libnotify_rs/lib.rs
1//! This crate exposes two modules:
2//!
3//! # Crate structure
4//! ## Api
5//! This module contains a basic wrapper for libnotify calls. It just translates data types, etc,
6//! so usage is basically the same as libnotify.
7//!
8//! ## Wrappers
9//! This module is a higher level abstraction over api. Recommended to use over api.
10//!
11//! # Features
12//!
13//! - clap – enables [clap](https://docs.rs/clap/latest/clap/) support for `Urgency`
14//!
15#![allow(non_upper_case_globals)]
16#![allow(non_camel_case_types)]
17#![allow(non_snake_case)]
18#![warn(missing_docs)]
19#![warn(clippy::missing_errors_doc)]
20
21#[cfg(not(target_os = "linux"))]
22compile_error!("Libnotify-rs only supports linux");
23
24/// Basic libnotify rust wrapper
25pub mod api;
26/// Higher level abstraction over api
27pub mod wrappers;
28
29pub use wrappers::{builder, context};