Merge pull request #11 from szymon-jozef/chore/onezerozerobump

chore: version bump, metadata update, readme update

Cargo.lock

@@ -11,6 +11,56 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "anstream"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is_terminal_polyfill",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000"
+
+[[package]]
+name = "anstyle-parse"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc"
+dependencies = [
+ "windows-sys",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "3.0.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d"
+dependencies = [
+ "anstyle",
+ "once_cell_polyfill",
+ "windows-sys",
+]
+
 [[package]]
 name = "bindgen"
 version = "0.73.2"
@@ -47,9 +97,9 @@ dependencies = [
 
 [[package]]
 name = "cfg-expr"
-version = "0.20.9"
+version = "0.20.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fe4ece8474b5f766c63426647e7b4b316b67431ade1036a8313cee24a03ae917"
+checksum = "9ba9e9ec16c447027685b1f897b720e18e9a8afd00bd7332c483537e38086c9f"
 dependencies = [
  "smallvec",
  "target-lexicon",
@@ -72,6 +122,39 @@ dependencies = [
  "libloading",
 ]
 
+[[package]]
+name = "clap"
+version = "4.6.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "aa8876b300ab35ba921adea3dfd70157a46249b33f95c9084ae5709785478946"
+dependencies = [
+ "clap_builder",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.6.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0797fb7aeb1406c84efac526901f7ec3ead2124f946b494e72879d4b54704d"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "clap_lex",
+ "strsim",
+]
+
+[[package]]
+name = "clap_lex"
+version = "1.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1c133bc6a41be0d194c306b5506d15e6feeea7b1d6604bd3f8310dfb2ca96486"
+
+[[package]]
+name = "colorchoice"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570"
+
 [[package]]
 name = "equivalent"
 version = "1.0.2"
@@ -230,10 +313,16 @@ dependencies = [
 ]
 
 [[package]]
-name = "libc"
+name = "is_terminal_polyfill"
-version = "0.2.189"
+version = "1.70.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2"
+checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695"
+
+[[package]]
+name = "libc"
+version = "0.2.190"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce5d3ddc6d3fa000eb1536d85e147bfe31aacaba692ed6a876f95cb7c855be78"
 
 [[package]]
 name = "libloading"
@@ -247,9 +336,10 @@ dependencies = [
 
 [[package]]
 name = "libnotify-rs"
-version = "0.2.0"
+version = "1.0.0"
 dependencies = [
  "bindgen",
+ "clap",
  "glib",
  "pkg-config",
  "serial_test",
@@ -298,6 +388,12 @@ version = "1.21.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
 
+[[package]]
+name = "once_cell_polyfill"
+version = "1.70.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
+
 [[package]]
 name = "parking_lot"
 version = "0.12.5"
@@ -483,6 +579,12 @@ version = "1.16.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f9395f0f0eee849a9b707b2f06bb92a6a422090e2123bb2ef8e87a0e61892a8e"
 
+[[package]]
+name = "strsim"
+version = "0.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
+
 [[package]]
 name = "syn"
 version = "3.0.6"
@@ -558,6 +660,12 @@ version = "1.0.26"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d245f478577f809a851594d02313b640fb437e0bb33866753cff937863096954"
 
+[[package]]
+name = "utf8parse"
+version = "0.2.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
+
 [[package]]
 name = "version-compare"
 version = "0.2.1"

Cargo.toml

@@ -1,16 +1,19 @@
 [package]
 name = "libnotify-rs"
-version = "0.2.1"
+version = "1.0.0"
 edition = "2024"
 authors = [ "szymon_jozef"]
 description = "Rust bindings for libnotify"
 readme = "./README.md"
-homepage = "https://github.com/szymon-jozef/libnotify-rs"
 repository = "https://github.com/szymon-jozef/libnotify-rs"
+documentation = "https://szymon-jozef.github.io/libnotify-rs/libnotify_rs/index.html"
 license = "MIT"
-keywords = [ "bindings", "libnotify" ]
+keywords = [ "bindings", "libnotify", "notificatons" ]
 build = "./build.rs"
 
+[dependencies]
+clap = {version = "4.6.7", optional = true}
+
 [build-dependencies]
 pkg-config = "0.3.34"
 bindgen = "0.73.2"
@@ -18,3 +21,6 @@ bindgen = "0.73.2"
 [dev-dependencies]
 glib = "0.22.10"
 serial_test = "4.0.1"
+
+[features]
+clap = [ "dep:clap" ]

README.md

@@ -19,14 +19,7 @@
 
 This crate exposes a user friendly (at least I hope), Rust api for [libnotify](https://gitlab.gnome.org/GNOME/libnotify). Made using [bindgen](https://github.com/rust-lang/rust-bindgen).
 
-## Structure
+It comes with basic libnotify calls bindings and higher level abstraction over it.
-Project is split into two modules:
-- functions
-- notifications
-
-Which resembles libnotify structure. Every function is named similarly to its libnotify counterpart and it does the same things.
-
-There are some helper structs and enums to make it more approachable to rust folks.
 
 ## Documentation
 Available at [github pages](https://szymon-jozef.github.io/libnotify-rs/libnotify_rs/index.html);
@@ -34,7 +27,7 @@ Available at [github pages](https://szymon-jozef.github.io/libnotify-rs/libnotif
 ## Add to project
 Type in:
 ```bash
-cargo add --git "https://github.com/szymon-jozef/libnotify-rs"
+cargo add libnotify-rs
 ```
 
 ### Nix flake
@@ -56,22 +49,26 @@ packages = [
 
 ## Dependencies
 To use this crate you need to have installed:
-- [libnotify](https://gitlab.gnome.org/GNOME/libnotify), duh (version 0.8.8 >= is supported)
+- [libnotify](https://gitlab.gnome.org/GNOME/libnotify), duh (version 0.8.8 >= is tested. Older versions may work, but are unsupported)
 - [clang](https://clang.llvm.org/) for bindgen
 - [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/?__goaway_challenge=meta-refresh&__goaway_id=e567f4f3ff21df0fb2b589fc86ed197e&__goaway_referer=https%3A%2F%2Fsearch.brave.com%2F), to find the above
 
 ## Examples
 Refer to [examples dir](./examples)
 
+Also have a look at [notify-send-rs](https://github.com/szymon-jozef/notify-send-rs). That's a small notify-send clone I made with this lib, as an example.
+
 Sneak peek for making a notification:
 
+### Without my super cool wrapper (:()
+
 ```rust
-use libnotify_rs::{
+use libnotify_rs::api::{
     functions::{init, uninit},
-    notification::Notification,
+    notification::{self, Notification},
 };
 
-fn main() -> Result<(), Box<dyn std::error::Error>> {
+fn main() -> Result<(), LibnotifyError> {
     init("I love coffee")?;
     let mut notify = Notification::new(
         "Remember to drink coffe!",
@@ -79,8 +76,8 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         None,
     )?;
 
-    notify.set_timeout(libnotify_rs::notification::Timeout::Custom(1000 * 10)); // 10 secs
+    notify.set_timeout(notification::Timeout::Custom(1000 * 10)); // 10 secs
-    notify.set_urgency(libnotify_rs::notification::Urgency::Critical); // coffee is very important
+    notify.set_urgency(notification::Urgency::Critical); // coffee is very important
     notify.set_category("Coffee")?;
 
     notify.show()?;
@@ -91,6 +88,36 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 }
 ```
 
+### With my super cool wrapper (:))
+
+```rust
+use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+
+/// Builder is recommended way to interact with libnotify notifications
+
+fn main() -> Result<(), LibnotifyError> {
+    let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+
+    let notification_builder = NotificationBuilder::new(
+        "Remember about your coffee!",
+        "Only idiots forget about coffee!",
+        None,
+        &ctx,
+    )?
+    .set_urgency(libnotify_rs::api::notification::Urgency::Critical)
+    .set_timeout(libnotify_rs::api::notification::Timeout::Never)
+    .set_category("Coffee")?;
+
+    notification_builder.show()?;
+
+    // you don't need to uninitialize libnotify, cause context already does that!
+
+    Ok(())
+}
+
+```
+
+
 To test those examples use:
 ```bash
 cargo r --example <example name>
@@ -116,6 +143,3 @@ It didn't write any of the actual code, nor any documentation.
 
 ## Roadmap
 I will be happy to fix any bugs that you may find! Just create a new issue, or better yet a pull request.
-
-I'm thinking about a small wrapper around other code, which would initialize libnotify by itself, cleanup after itself, etc. Maybe someday…
-

build.rs

@@ -2,7 +2,9 @@ use std::env;
 use std::path::PathBuf;
 
 fn main() {
-    let library = pkg_config::Config::new().probe("libnotify").unwrap();
+    let library = pkg_config::Config::new()
+        .probe("libnotify")
+        .expect("Cannot locate libnotify. Is it installed?");
 
     let paths = library
         .include_paths
@@ -17,7 +19,8 @@ fn main() {
         .generate()
         .expect("Unable to generate bindings");
 
-    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let out_path =
+        PathBuf::from(env::var("OUT_DIR").expect("Out $OUT_DIR not set. Perhaps a bindgen error?"));
 
     bindings
         .write_to_file(out_path.join("bindings.rs"))

src/api/errors.rs

@@ -0,0 +1,58 @@
+/// Enum mapping every possible error that can happen in this lib, with a nice enum.
+#[derive(Debug)]
+pub enum LibnotifyError {
+    /// [Libnotify init](https://gnome.pages.gitlab.gnome.org/libnotify/func.init.html) failed
+    InitError,
+    /// `&str` contains a null terminator. Read more at [std documentation](https://doc.rust-lang.org/std/ffi/struct.NulError.html)
+    NulError(std::ffi::NulError),
+    /// [Libnotify notification constructor](https://gnome.pages.gitlab.gnome.org/libnotify/ctor.Notification.new.html) failed allocating
+    NewNotificationError,
+    /// Custom libnotify error with explanation.
+    GerrorError(String),
+    /// Data failed allocating. Could indicate that system doesn't have enough memory
+    AllocationError,
+}
+
+impl std::fmt::Display for LibnotifyError {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        match self {
+            LibnotifyError::InitError => {
+                write!(f, "Libnotify failed to init")
+            }
+
+            LibnotifyError::NulError(_) => {
+                write!(f, "Argument contains a null terminator")
+            }
+
+            LibnotifyError::NewNotificationError => {
+                write!(f, "Notification constructor failed")
+            }
+
+            LibnotifyError::GerrorError(e) => {
+                write!(f, "Libnotify returned an error: {}", e)
+            }
+
+            LibnotifyError::AllocationError => {
+                write!(f, "Libnotify failed allocating memory")
+            }
+        }
+    }
+}
+
+impl std::error::Error for LibnotifyError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        match self {
+            LibnotifyError::InitError => None,
+            LibnotifyError::NulError(nul_error) => Some(nul_error),
+            LibnotifyError::NewNotificationError => None,
+            LibnotifyError::GerrorError(_) => None,
+            LibnotifyError::AllocationError => None,
+        }
+    }
+}
+
+impl From<std::ffi::NulError> for LibnotifyError {
+    fn from(value: std::ffi::NulError) -> Self {
+        Self::NulError(value)
+    }
+}

src/api/functions.rs

@@ -1,3 +1,5 @@
+use crate::api::errors::LibnotifyError;
+
 use super::utils::c_str_to_rs_str_and_free;
 
 use super::libnotify::*;
@@ -7,10 +9,29 @@ use super::libnotify::*;
  *(what a cool section comment)
 */
 
-/// Initialized libnotify. This must be called before any other functions.
+/// Initializes libnotify. This must be called before any other functions.
 ///
 /// Starting from 0.8, if the provided app_name is NULL, libnotify will try to figure it out from the running application. Before it was not allowed, and was causing libnotify not to be initialized.
-pub fn init<'a, T>(app_name: T) -> Result<(), Box<dyn std::error::Error>>
+///
+/// # Example
+///
+/// ```
+/// use libnotify_rs::api::{
+///     functions::init,
+///     notification:: Notification,
+/// };
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     init("Test app")?; // we need to init libnotify __before__ any other libnotify code
+///     let notification = Notification::new("Test", None, None)?; // Some libnotify call
+///     Ok(())
+/// }
+///
+/// ```
+///
+/// # Errors
+/// This function can return LibnotifyError::{InitError, NulError}
+pub fn init<'a, T>(app_name: T) -> Result<(), LibnotifyError>
 where
     T: Into<Option<&'a str>>,
 {
@@ -24,7 +45,7 @@ where
         )
     } == 0
     {
-        return Err("Libnotify init failed".into());
+        return Err(LibnotifyError::InitError);
     }
 
     Ok(())
@@ -33,6 +54,19 @@ where
 /// Uninitializes libnotify.
 ///
 /// This should be called when the program no longer needs libnotify for the rest of its lifecycle, typically just before exitting.
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{init, uninit};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     init("Test app")?;
+///     // let notify = ...
+///     uninit(); // __always__ uninit libnotify after use
+///     Ok(())
+/// }
+///
+/// ```
 pub fn uninit() {
     unsafe {
         notify_uninit();
@@ -40,6 +74,20 @@ pub fn uninit() {
 }
 
 /// Gets whether or not libnotify is initialized.
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{init, is_initted};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     if !is_initted() { // useful for conditional initing
+///         init("Test app")?;
+///     }
+///
+///     Ok(())
+/// }
+///
+/// ```
 pub fn is_initted() -> bool {
     unsafe { notify_is_initted() != 0 }
 }
@@ -49,6 +97,20 @@ pub fn is_initted() -> bool {
 */
 
 /// Gets the application name registered.
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{get_app_name, init};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     let app_name = "Test app";
+///     init(app_name)?;
+///     let app_name_gotten: String = get_app_name().ok_or::<String>("No name gotten".into())?;
+///     assert_eq!(app_name, app_name_gotten);
+///     Ok(())
+/// }
+///
+/// ```
 pub fn get_app_name() -> Option<String> {
     let app_name_c: *const std::os::raw::c_char = unsafe { notify_get_app_name() };
 
@@ -65,6 +127,20 @@ pub fn get_app_name() -> Option<String> {
 
 /// Gets the application icon registered.
 /// Available since: 0.8.4
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{get_app_icon, get_app_name, init, set_app_icon};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     init("Test app")?;
+///     let icon = "gimp";
+///     set_app_icon(icon)?;
+///     let icon_gotten = get_app_icon().ok_or::<String>("No app icon set".into())?;
+///     assert_eq!(icon, icon_gotten);
+///     Ok(())
+/// }
+/// ```
 pub fn get_app_icon() -> Option<String> {
     let app_icon_c: *const std::os::raw::c_char = unsafe { notify_get_app_icon() };
 
@@ -81,6 +157,27 @@ pub fn get_app_icon() -> Option<String> {
 
 /// Queries the server capabilities.
 /// Synchronously queries the server for its capabilities and returns them in a list.
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{self, uninit};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     functions::init("Test app")?;
+///
+///     if let Some(caps) = functions::get_server_caps() {
+///         println!("=== Server caps ===");
+///         for s in caps {
+///             println!("{}", s);
+///         }
+///     } else {
+///         eprintln!("No server caps");
+///     }
+///     
+///     Ok(())
+/// }
+///
+/// ```
 pub fn get_server_caps() -> Option<Vec<String>> {
     let mut vec: Vec<String> = vec![];
 
@@ -130,6 +227,41 @@ pub struct ServerInfo {
 
 /// Queries the server for information.
 /// Synchronously queries the server for its information, specifically, the name, vendor, server version, and the version of the notifications specification that it is compliant with.
+///
+/// # Example
+/// ```
+///
+/// use libnotify_rs::api::functions::{self, uninit};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     functions::init("Test app")?;
+///
+///     if let Some(info) = functions::get_server_info() {
+///         println!("=== Server info ===");
+///         if let Some(name) = info.name {
+///             println!("Server name: {}", name);
+///         }
+///
+///         if let Some(vendor) = info.vendor {
+///             println!("Server vendor: {}", vendor);
+///         }
+///
+///         if let Some(version) = info.version {
+///             println!("Server version: {}", version);
+///         }
+///
+///         if let Some(spec_version) = info.spec_version {
+///             println!("Server spec version: {}", spec_version);
+///         }
+///     } else {
+///         eprintln!("No server info");
+///     }
+///
+///     uninit();
+///
+///     Ok(())
+/// }
+/// ```
 pub fn get_server_info() -> Option<ServerInfo> {
     let mut ret_name = std::ptr::null_mut() as *mut std::os::raw::c_char;
     let mut ret_vendor = std::ptr::null_mut() as *mut std::os::raw::c_char;
@@ -161,7 +293,23 @@ pub fn get_server_info() -> Option<ServerInfo> {
 */
 
 /// Sets the application name
-pub fn set_app_name(app_name: &str) -> Result<(), std::ffi::NulError> {
+///
+/// # Errors
+/// This function can return LibnotifyError::NulError
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{get_app_name, init, set_app_name};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     init("Test app")?;
+///     let app_name = "morbius app";
+///     set_app_name(app_name)?;
+///     assert_eq!(app_name, get_app_name().unwrap());
+///     Ok(())
+/// }
+/// ```
+pub fn set_app_name(app_name: &str) -> Result<(), LibnotifyError> {
     let app_name_c = std::ffi::CString::new(app_name)?;
     unsafe { notify_set_app_name(app_name_c.as_ptr()) };
 
@@ -172,7 +320,23 @@ pub fn set_app_name(app_name: &str) -> Result<(), std::ffi::NulError> {
 /// Available since: 0.8.4
 ///
 /// app_icon is icon name or path to an image
-pub fn set_app_icon(app_icon: &str) -> Result<(), std::ffi::NulError> {
+///
+/// # Errors
+/// This function can return LibnotifyError::NulError
+///
+/// # Example
+/// ```
+/// use libnotify_rs::api::functions::{get_app_icon, init, set_app_icon};
+///
+/// fn main() -> Result<(), Box<dyn std::error::Error>> {
+///     init("Test app")?;
+///     let app_icon = "morbius app";
+///     set_app_icon(app_icon)?;
+///     assert_eq!(app_icon, get_app_icon().unwrap());
+///     Ok(())
+/// }
+/// ```
+pub fn set_app_icon(app_icon: &str) -> Result<(), LibnotifyError> {
     let app_icon_c = std::ffi::CString::new(app_icon)?;
     unsafe { notify_set_app_icon(app_icon_c.as_ptr()) };
 
@@ -195,11 +359,10 @@ mod tests {
 
     #[test]
     fn test_bad_init() {
-        assert!(
+        assert!(matches!(
-            init("Mor\0ius")
+            init("Mor\0ius").unwrap_err(),
-                .unwrap_err()
+            LibnotifyError::NulError(_)
-                .is::<std::ffi::c_str::NulError>()
+        ));
-        );
     }
 
     #[test]

src/api/mod.rs

@@ -1,3 +1,5 @@
+/// Custom error types
+pub mod errors;
 /// Same as [libnotify global functions](https://gnome.pages.gitlab.gnome.org/libnotify/index.html#functions)
 pub mod functions;
 mod libnotify;

src/api/notification.rs

@@ -1,6 +1,9 @@
+use crate::api::errors::LibnotifyError;
+
 use super::libnotify::*;
 
 #[derive(Debug, Clone, Copy)]
+#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
 /// Notification urgency level. Refer to [libnotify docs](https://gnome.pages.gitlab.gnome.org/libnotify/enum.Urgency.html) for more info
 pub enum Urgency {
     /// Low urgency. Used for unimportant notifications
@@ -62,12 +65,25 @@ impl<'a> Notification {
     /// Create new notification.
     ///
     /// # Errors
-    /// This function will return an error if the supplied bytes contain an
+    /// This function can return LibnotifyError::{NewNotificationError, NulError}
-    /// internal 0 byte. The [`NulError`](https://doc.rust-lang.org/stable/alloc/ffi/c_str/struct.NulError.html) returned will contain the bytes as well as
-    /// the position of the nul byte.
     ///
-    /// On libnotify fail it will return Err(&str.into). May change in the future.
+    /// # Example
-    pub fn new<T, Y>(summary: &str, body: T, icon: Y) -> Result<Self, Box<dyn std::error::Error>>
+    /// ```
+    ///
+    /// use libnotify_rs::api::{
+    ///     functions::{init, uninit},
+    ///     notification::Notification,
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Test app")?;
+    ///     let notification = Notification::new("My notification", "Yap yap", None)?;
+    ///     // ...
+    ///     uninit();
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn new<T, Y>(summary: &str, body: T, icon: Y) -> Result<Self, LibnotifyError>
     where
         T: Into<Option<&'a str>>,
         Y: Into<Option<&'a str>>,
@@ -87,7 +103,7 @@ impl<'a> Notification {
         };
 
         if inner.is_null() {
-            return Err("notify_notification_new returned null".into());
+            return Err(LibnotifyError::NewNotificationError);
         }
 
         Ok(Self { inner })
@@ -95,6 +111,8 @@ impl<'a> Notification {
 
     /// Add callback to notification.
     ///
+    /// This function needs a [glib mainloop](https://docs.gtk.org/glib/main-loop.html)
+    ///
     /// # Args
     /// `action` – action identifier. `default` will work for most use cases. Other text will be
     /// displayed as button names.
@@ -102,12 +120,48 @@ impl<'a> Notification {
     /// `label` – label for user
     ///
     /// `callback` - any closure that accepts &str as an argument, where &str is action name.
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::NulError
+    ///
+    /// # Example
+    /// ```no_run(There's no notification deamon on CI and no one to click the notification)
+    /// use glib::MainLoop;
+    /// use libnotify_rs::{
+    ///     api::functions::{init, uninit},
+    ///     api::notification::Notification,
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Coffee reminder")?;
+    ///     let mut notify = Notification::new("Drink coffee", "Click me when you're done drinking", None)?;
+    ///
+    ///     // We need to have  a glib main loop in order to receive callback actions
+    ///     let main_loop = MainLoop::new(None, false);
+    ///     let loop_clone = main_loop.clone();
+    ///
+    ///     notify.add_action("default", "I'm drinking!", move |action_name| {
+    ///         println!("User drunk his coffee!");
+    ///         println!("Action was named: {}", action_name);
+    ///         loop_clone.quit();
+    ///     })?;
+    ///
+    ///     notify.show()?;
+    ///     main_loop.run();
+    ///
+    ///     println!("Glib mainloop has ended");
+    ///
+    ///     uninit();
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn add_action<F>(
         &mut self,
         action: &str,
         label: &str,
         callback: F,
-    ) -> Result<(), Box<dyn std::error::Error>>
+    ) -> Result<(), LibnotifyError>
     where
         F: Fn(&str) + 'static,
     {
@@ -134,6 +188,32 @@ impl<'a> Notification {
     }
 
     /// Clears all actions from the notification
+    ///
+    /// # Example
+    /// ```
+    /// use libnotify_rs::api::{
+    ///     functions::{init, uninit},
+    ///     notification::Notification,
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Test app")?;
+    ///     let mut notification = Notification::new("My notification", "Yap yap", None)?;
+    ///     notification.add_action("default", "yap", |action| {
+    ///         // do stuff
+    ///     })?;
+    ///
+    ///     notification.add_action("click", "yappers", |action| {
+    ///         // do some other stuff
+    ///     })?;
+    ///
+    ///     notification.clear_actions(); // now there are no callbacks!
+    ///
+    ///     uninit();
+    ///     Ok(())
+    /// }
+    /// ```
+    ///
     pub fn clear_actions(&mut self) {
         unsafe { notify_notification_clear_actions(self.inner) }
     }
@@ -144,19 +224,38 @@ impl<'a> Notification {
     }
 
     /// Synchronously tells the notification server to hide the notification on the screen
-    pub fn close(&self) -> Result<(), Box<dyn std::error::Error>> {
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{AllocationError, GerrorError}
+    ///
+    /// # Example
+    /// ```no_run(Not notification deamon on CI)
+    /// use libnotify_rs::api::{functions::init, notification::Notification};
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Test app")?;
+    ///     let notification = Notification::new("My notification", "Yap yap", None)?;
+    ///     notification.show()?;
+    ///     std::thread::sleep(std::time::Duration::from_secs(5)); // To do this you can just set duration,
+    ///     // but this is an example
+    ///     notification.close()?; // After 5 seconds no notification
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn close(&self) -> Result<(), LibnotifyError> {
         let mut gerror = std::ptr::null_mut() as *mut GError;
 
         if unsafe { notify_notification_close(self.inner, &mut gerror) } == 0 {
             if gerror.is_null() {
-                return Err("Unknown error".into());
+                return Err(LibnotifyError::AllocationError);
             }
 
             let e = unsafe { *gerror }.message;
 
             if e.is_null() {
                 unsafe { g_error_free(gerror) };
-                return Err("Unknown error".into());
+                return Err(LibnotifyError::AllocationError);
             }
 
             let e_str = unsafe { std::ffi::CStr::from_ptr(e) }
@@ -165,7 +264,7 @@ impl<'a> Notification {
 
             unsafe { g_error_free(gerror) };
 
-            return Err(e_str.into());
+            return Err(LibnotifyError::GerrorError(e_str));
         }
 
         Ok(())
@@ -174,6 +273,37 @@ impl<'a> Notification {
     /// Returns the closed reason code for the notification.
     ///
     /// This is valid only after the Notification::closed signal is emitted.
+    ///
+    /// This function needs a [glib mainloop](https://docs.gtk.org/glib/main-loop.html)
+    ///
+    /// # Example
+    /// ```no_run(No notificaton daemon on CI)
+    /// use glib::MainLoop;
+    /// use libnotify_rs::{
+    ///     api::functions::{init, uninit},
+    ///     api::notification::Notification,
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Coffee reminder")?;
+    ///     let mut notify = Notification::new("Drink coffee", "Click me when you're done drinking", None)?;
+    ///
+    ///     // We need to have  a glib main loop in order to receive closed_reason
+    ///     let main_loop = MainLoop::new(None, false);
+    ///     let loop_clone = main_loop.clone();
+    ///
+    ///     notify.show()?;
+    ///     main_loop.run();
+    ///
+    ///     // Thanks to the main loop we can also read why the notification was closed
+    ///     println!(
+    ///         "Notification closed, because: {:?}",
+    ///         notify.get_closed_reason()
+    ///     );
+    ///
+    ///     Ok(())
+    /// }
+    ///```
     pub fn get_closed_reason(&self) -> ClosedReason {
         match unsafe { notify_notification_get_closed_reason(self.inner) } {
             NotifyClosedReason_NOTIFY_CLOSED_REASON_UNSET => ClosedReason::Unset,
@@ -187,11 +317,17 @@ impl<'a> Notification {
 
     /// Sets the application icon for the notification.
     ///
+    /// Refer to the [documentation](https://specifications.freedesktop.org/icon-naming/latest/) for
+    /// icon names.
+    ///
     /// If this function is not called, the application icon will be set from the value set via
-    /// `set_app_icon()`.
+    /// `set_app_icon()`. Usage is the same.
     ///
     /// Available since: 0.8.4
-    pub fn set_app_icon(&mut self, app_icon: &str) -> Result<(), std::ffi::NulError> {
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    pub fn set_app_icon(&mut self, app_icon: &str) -> Result<(), LibnotifyError> {
         let app_icon_c = std::ffi::CString::new(app_icon)?;
         unsafe { notify_notification_set_app_icon(self.inner, app_icon_c.as_ptr()) };
 
@@ -200,10 +336,13 @@ impl<'a> Notification {
 
     /// Sets the application name for the notification.
     ///
-    /// If this function is not called, the application name will be set from the value used in init() or overridden with set_app_name().
+    /// If this function is not called, the application name will be set from the value used in init() or overridden with set_app_name(). Usage is the same.
     ///
     /// Available since: 0.7.3
-    pub fn set_app_name(&mut self, app_name: &str) -> Result<(), std::ffi::NulError> {
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    pub fn set_app_name(&mut self, app_name: &str) -> Result<(), LibnotifyError> {
         let app_name_c = std::ffi::CString::new(app_name)?;
         unsafe { notify_notification_set_app_name(self.inner, app_name_c.as_ptr()) };
 
@@ -213,7 +352,12 @@ impl<'a> Notification {
     /// Sets the category of this notification.
     ///
     /// This can be used by the notification server to filter or display the data in a certain way
-    pub fn set_category(&mut self, category: &str) -> Result<(), std::ffi::NulError> {
+    ///
+    /// The only reference to what this even is, is [this thread](https://unix.stackexchange.com/questions/251243/what-do-a-notify-send-notification-category-hint-and-version-parameters-mean). If you know how to use this bad boy, have fun :D
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    pub fn set_category(&mut self, category: &str) -> Result<(), LibnotifyError> {
         let category_c = std::ffi::CString::new(category)?;
         unsafe { notify_notification_set_category(self.inner, category_c.as_ptr()) };
 
@@ -223,11 +367,13 @@ impl<'a> Notification {
     /// Sets a hint for key with value value
     ///
     /// Available since: 0.6
-    pub fn set_hint(
+    ///
-        &mut self,
+    ///
-        key: &str,
+    /// The only reference to what this even is, is [this thread](https://unix.stackexchange.com/questions/251243/what-do-a-notify-send-notification-category-hint-and-version-parameters-mean). If you know how to use this bad boy, have fun :D
-        value: HintValue,
+    ///
-    ) -> Result<(), Box<dyn std::error::Error>> {
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError, AllocationError}
+    pub fn set_hint(&mut self, key: &str, value: HintValue) -> Result<(), LibnotifyError> {
         let key_c = std::ffi::CString::new(key)?;
 
         let value_c = match value {
@@ -242,7 +388,7 @@ impl<'a> Notification {
         };
 
         if value_c.is_null() {
-            return Err("Couldn't create hint value".into());
+            return Err(LibnotifyError::AllocationError);
         }
 
         unsafe { notify_notification_set_hint(self.inner, key_c.as_ptr(), value_c) };
@@ -253,6 +399,26 @@ impl<'a> Notification {
     /// Sets the timeout of the notification.
     ///
     /// Note that the timeout may be ignored by the server.
+    ///
+    /// # Example
+    /// ```
+    /// use libnotify_rs::api::{
+    ///     functions::{init, uninit},
+    ///     notification::{self, Notification},
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("I love coffee")?;
+    ///     let mut notify = Notification::new(
+    ///         "Remember to drink coffe!",
+    ///         "Coffee is very important for your mental health!",
+    ///         None,
+    ///     )?;
+    ///
+    ///     notify.set_timeout(notification::Timeout::Custom(1000 * 10)); // 10 secs
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn set_timeout(&mut self, timeout: Timeout) {
         let timeout_c = match timeout {
             Timeout::Default => NOTIFY_EXPIRES_DEFAULT,
@@ -264,6 +430,25 @@ impl<'a> Notification {
     }
 
     /// Sets the urgency level of this notification
+    /// # Example
+    /// ```
+    /// use libnotify_rs::api::{
+    ///     functions::{init, uninit},
+    ///     notification::{self, Notification},
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("I love coffee")?;
+    ///     let mut notify = Notification::new(
+    ///         "Remember to drink coffe!",
+    ///         "Coffee is very important for your mental health!",
+    ///         None,
+    ///     )?;
+    ///
+    ///     notify.set_urgency(notification::Urgency::Critical); // coffee is very important
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn set_urgency(&mut self, urgency: Urgency) {
         let urgency: u32 = match urgency {
             Urgency::Low => NotifyUrgency_NOTIFY_URGENCY_LOW,
@@ -275,19 +460,43 @@ impl<'a> Notification {
     }
 
     /// Tells the notification server to display the notification on the screen
-    pub fn show(&self) -> Result<(), Box<dyn std::error::Error>> {
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{GerrorError, AllocationError}
+    ///
+    /// # Example
+    /// ```no_run(No notification daemon on CI)
+    /// use libnotify_rs::api::{
+    ///     functions::{init, uninit},
+    ///     notification::{self, Notification},
+    /// };
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("I love coffee")?;
+    ///     let mut notify = Notification::new(
+    ///         "Remember to drink coffe!",
+    ///         "Coffee is very important for your mental health!",
+    ///         None,
+    ///     )?;
+    ///
+    ///     notify.show()?;
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn show(&self) -> Result<(), LibnotifyError> {
         let mut gerror = std::ptr::null_mut() as *mut GError;
 
         if unsafe { notify_notification_show(self.inner, &mut gerror) } == 0 {
             if gerror.is_null() {
-                return Err("Unknown error".into());
+                return Err(LibnotifyError::AllocationError);
             }
 
             let err_msg = unsafe { *gerror }.message;
 
             if err_msg.is_null() {
                 unsafe { g_error_free(gerror) };
-                return Err("Unknown error".into());
+                return Err(LibnotifyError::AllocationError);
             }
 
             let err_msg_str = unsafe { std::ffi::CStr::from_ptr(err_msg) }
@@ -295,7 +504,7 @@ impl<'a> Notification {
                 .to_string();
 
             unsafe { g_error_free(gerror) };
-            return Err(err_msg_str.into());
+            return Err(LibnotifyError::GerrorError(err_msg_str));
         }
 
         Ok(())
@@ -304,12 +513,28 @@ impl<'a> Notification {
     /// Updates the notification text and icon.
     ///
     /// This won’t send the update out and display it on the screen. For that, you will need to call `show()`.
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    ///
+    /// # Example
+    /// ```
+    /// use libnotify_rs::api::{functions::init, notification::Notification};
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     init("Test app")?;
+    ///     let mut notification = Notification::new("My notification", "Yap yap", None)?;
+    ///     notification.update("My new summary", "My new body", None)?;
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn update<'b, F, I>(
         &mut self,
         summary: &str,
         body: F,
         icon: I,
-    ) -> Result<(), std::ffi::NulError>
+    ) -> Result<(), LibnotifyError>
     where
         F: Into<Option<&'b str>>,
         I: Into<Option<&'b str>>,
@@ -343,6 +568,7 @@ impl Drop for Notification {
     }
 }
 
+/// This function translates c callback to rust. Used in `add_action`
 unsafe extern "C" fn action_trampoline<F>(
     _notification: *mut NotifyNotification,
     action: *mut ::std::os::raw::c_char,
@@ -360,6 +586,7 @@ unsafe extern "C" fn action_trampoline<F>(
     callback(&action);
 }
 
+/// This function tells c how to free memory of our callback
 unsafe extern "C" fn drop_box<F>(data: gpointer) {
     unsafe { drop(Box::from_raw(data as *mut F)) };
 }
@@ -395,4 +622,7 @@ mod tests {
                 .is_null()
         );
     }
+
+    // I meant to write more tests, but I'm to lazy :3
+    // Doctests should suffice
 }

src/lib.rs

@@ -1,16 +1,25 @@
 //! This crate exposes two modules:
 //!
-//! # Api
+//! # Crate structure
+//! ## Api
 //! This module contains a basic wrapper for libnotify calls. It just translates data types, etc,
 //! so usage is basically the same as libnotify.
 //!
-//! # Wrappers
+//! ## Wrappers
 //! This module is a higher level abstraction over api. Recommended to use over api.
 //!
+//! # Features
+//!
+//! - clap – enables [clap](https://docs.rs/clap/latest/clap/) support for `Urgency`
+//!
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
 #![warn(missing_docs)]
+#![warn(clippy::missing_errors_doc)]
+
+#[cfg(not(target_os = "linux"))]
+compile_error!("Libnotify-rs only supports linux");
 
 /// Basic libnotify rust wrapper
 pub mod api;

src/wrappers/builder.rs

@@ -1,5 +1,8 @@
 use crate::{
-    api::notification::{HintValue, Notification, Timeout, Urgency},
+    api::{
+        errors::LibnotifyError,
+        notification::{HintValue, Notification, Timeout, Urgency},
+    },
     wrappers::context::LibnotifyContext,
 };
 
@@ -12,6 +15,33 @@ pub struct NotificationBuilder<'a> {
 
 impl<'a> NotificationBuilder<'a> {
     /// Create new NotificationBuilder, with given context.
+    ///
+    /// # Errors
+    ///
+    /// This function can return LibnotifyError::{NewNotificationError, NulError}
+    ///
+    /// # Example
+    /// ```
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// // Builder is recommended way to interact with libnotify notifications
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?;
+    ///
+    ///     // you don't need to uninitialize libnotify, cause context already does that!
+    ///
+    ///     Ok(())
+    /// }
+    ///
+    /// ```
     pub fn new<T, Y>(
         summary: &str,
         body: T,
@@ -31,52 +61,168 @@ impl<'a> NotificationBuilder<'a> {
     }
 
     /// Sets app name for this specific notification.
-    pub fn set_app_name(mut self, app_name: &str) -> Result<Self, std::ffi::NulError> {
+    ///
-        self.notification.set_app_name(app_name)?;
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    ///
+    /// # Example
+    /// ```ignore(Small example)
+    /// let notification_builder = NotificationBuilder::new(
+    ///     "Remember about your coffee!",
+    ///     "Only idiots forget about coffee!",
+    ///     None,
+    ///     &ctx,
+    /// )?
+    /// .set_app_name("Other app name");
+    /// ```
+    pub fn set_app_name<T: Into<Option<&'a str>>>(
+        mut self,
+        app_name: T,
+    ) -> Result<Self, LibnotifyError> {
+        if let Some(app_name) = app_name.into() {
+            self.notification.set_app_name(app_name)?;
+        }
+
         Ok(self)
     }
 
     /// Sets app icon fot this specific notification.
-    pub fn set_app_icon(mut self, app_icon: &str) -> Result<Self, std::ffi::NulError> {
+    ///
-        self.notification.set_app_icon(app_icon)?;
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    ///
+    /// # Example
+    /// ```ignore(Small example)
+    /// let notification_builder = NotificationBuilder::new(
+    ///     "Remember about your coffee!",
+    ///     "Only idiots forget about coffee!",
+    ///     None,
+    ///     &ctx,
+    /// )?
+    /// .set_app_icon("STOCK-HOME")?;
+    /// ```
+    pub fn set_app_icon<T: Into<Option<&'a str>>>(
+        mut self,
+        app_icon: T,
+    ) -> Result<Self, LibnotifyError> {
+        if let Some(app_icon) = app_icon.into() {
+            self.notification.set_app_icon(app_icon)?;
+        }
+
         Ok(self)
     }
 
     /// Sets category for this specific notification
-    pub fn set_category(mut self, category: &str) -> Result<Self, std::ffi::NulError> {
+    ///
-        self.notification.set_category(category)?;
+    /// # Errors
+    /// This function can return LibnotifyError::{NulError}
+    pub fn set_category<T: Into<Option<&'a str>>>(
+        mut self,
+        category: T,
+    ) -> Result<Self, LibnotifyError> {
+        if let Some(category) = category.into() {
+            self.notification.set_category(category)?;
+        }
+
         Ok(self)
     }
 
     /// Set hint for this specific notification
-    pub fn set_hint(
+    /// # Errors
-        mut self,
+    /// This function can return LibnotifyError::{NulError, AllocationError}
-        key: &str,
+    pub fn set_hint(mut self, key: &str, value: HintValue) -> Result<Self, LibnotifyError> {
-        value: HintValue,
-    ) -> Result<Self, Box<dyn std::error::Error>> {
         self.notification.set_hint(key, value)?;
         Ok(self)
     }
 
     /// Set timeout until close
-    pub fn set_timeout(mut self, timeout: Timeout) -> Self {
+    ///
-        self.notification.set_timeout(timeout);
+    /// # Example
+    /// ```
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?
+    ///     .set_timeout(libnotify_rs::api::notification::Timeout::Never);
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn set_timeout<T: Into<Option<Timeout>>>(mut self, timeout: T) -> Self {
+        if let Some(timeout) = timeout.into() {
+            self.notification.set_timeout(timeout);
+        }
+
         self
     }
 
     /// Set notification urgency level
-    pub fn set_urgency(mut self, urgency: Urgency) -> Self {
+    ///
-        self.notification.set_urgency(urgency);
+    /// # Example
+    /// ```
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?
+    ///     .set_urgency(libnotify_rs::api::notification::Urgency::Critical);
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn set_urgency<T: Into<Option<Urgency>>>(mut self, urgency: T) -> Self {
+        if let Some(urgency) = urgency.into() {
+            self.notification.set_urgency(urgency);
+        }
+
         self
     }
 
     /// Add callback
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::NulError
+    ///
+    /// # Example
+    /// ```
+    ///
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?
+    ///     .add_action("default", "super cool action", |action| {
+    ///         println!("Action: {} was run!", action);
+    ///     });
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn add_action<F>(
         mut self,
         action: &str,
         label: &str,
         callback: F,
-    ) -> Result<Self, Box<dyn std::error::Error>>
+    ) -> Result<Self, LibnotifyError>
     where
         F: Fn(&str) + 'static,
     {
@@ -87,13 +233,71 @@ impl<'a> NotificationBuilder<'a> {
     /// Show notification
     ///
     /// Uses `&self` borrow, so you can use this object later, after showing.
-    pub fn show(&self) -> Result<(), Box<dyn std::error::Error>> {
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{GerrorError, AllocationError}
+    ///
+    /// # Example
+    /// ```no_run(No notification daemon on CI)
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// /// Builder is recommended way to interact with libnotify notifications
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?
+    ///     .set_urgency(libnotify_rs::api::notification::Urgency::Critical)
+    ///     .set_timeout(libnotify_rs::api::notification::Timeout::Never)
+    ///     .set_category("Coffee")?;
+    ///
+    ///     notification_builder.show()?;
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn show(&self) -> Result<(), LibnotifyError> {
         self.notification.show()?;
         Ok(())
     }
 
     /// Close notification synchronously.
-    pub fn close(&self) -> Result<(), Box<dyn std::error::Error>> {
+    ///
+    /// Uses `&self` borrow, so you can use this object later, after closing.
+    ///
+    /// # Errors
+    /// This function can return LibnotifyError::{GerrorError, AllocationError}
+    ///
+    /// # Example
+    /// ```no_run(No notification daemon on CI)
+    /// use libnotify_rs::{builder::NotificationBuilder, context::LibnotifyContext};
+    ///
+    /// /// Builder is recommended way to interact with libnotify notifications
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?; // builder requires context
+    ///
+    ///     let notification_builder = NotificationBuilder::new(
+    ///         "Remember about your coffee!",
+    ///         "Only idiots forget about coffee!",
+    ///         None,
+    ///         &ctx,
+    ///     )?
+    ///     .set_urgency(libnotify_rs::api::notification::Urgency::Critical)
+    ///     .set_timeout(libnotify_rs::api::notification::Timeout::Never)
+    ///     .set_category("Coffee")?;
+    ///
+    ///     notification_builder.show()?;
+    ///     notification_builder.close()?;
+    ///     Ok(())
+    /// }
+    /// ```
+    pub fn close(&self) -> Result<(), LibnotifyError> {
         self.notification.close()?;
         Ok(())
     }

src/wrappers/context.rs

@@ -1,4 +1,7 @@
-use crate::api::functions::{init, is_initted, set_app_icon, set_app_name, uninit};
+use crate::api::{
+    errors::LibnotifyError,
+    functions::{init, is_initted, set_app_icon, set_app_name, uninit},
+};
 
 /// Notification context. Handles libnotify initializing and uninitializing.
 pub struct LibnotifyContext {}
@@ -9,9 +12,22 @@ static IS_CONTEXT_CREATED: std::sync::atomic::AtomicBool =
 impl LibnotifyContext {
     /// Try initializing libnotify
     ///
-    /// # Error
+    /// # Errors
     /// Returns an error, if libnotify cannot be initialized or if there already exists a context
     /// object
+    ///
+    /// # Example
+    /// ```
+    /// use libnotify_rs::context::LibnotifyContext;
+    ///
+    /// fn main() -> Result<(), Box<dyn std::error::Error>> {
+    ///     let ctx = LibnotifyContext::new("Coffee addicted reminder")?;
+    ///
+    ///     // you don't need to uninitialize libnotify, cause context already does that!
+    ///
+    ///     Ok(())
+    /// }
+    /// ```
     pub fn new(app_name: &str) -> Result<LibnotifyContext, Box<dyn std::error::Error>> {
         if IS_CONTEXT_CREATED.swap(true, std::sync::atomic::Ordering::SeqCst) {
             return Err("You can create only one context at a time".into());
@@ -25,13 +41,20 @@ impl LibnotifyContext {
     }
 
     /// Sets global app name
-    pub fn set_new_name(&self, app_name: &str) -> Result<(), std::ffi::NulError> {
+    /// # Errors
+    ///
+    /// This function can return LibnotifyError::NulError
+    pub fn set_new_name(&self, app_name: &str) -> Result<(), LibnotifyError> {
         set_app_name(app_name)?;
         Ok(())
     }
 
     /// Sets global app icon
-    pub fn set_app_icon(&self, app_icon: &str) -> Result<(), std::ffi::NulError> {
+    ///
+    /// # Errors
+    ///
+    /// This function can return LibnotifyError::NulError
+    pub fn set_app_icon(&self, app_icon: &str) -> Result<(), LibnotifyError> {
         set_app_icon(app_icon)?;
         Ok(())
     }