From c19c19e4db56678035d4aca4053128dfbcae7ed4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Orhun=20Parmaks=C4=B1z?= <orhunparmaksiz@gmail.com>
Date: Sat, 22 Oct 2022 21:26:33 +0300
Subject: [PATCH] docs: add usage example for `nix::Errno` conversion

---
 src/uucore/src/lib/mods/error.rs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/uucore/src/lib/mods/error.rs b/src/uucore/src/lib/mods/error.rs
index 9e1bbc09b..de53f2ef3 100644
--- a/src/uucore/src/lib/mods/error.rs
+++ b/src/uucore/src/lib/mods/error.rs
@@ -508,6 +508,20 @@ impl From<std::io::Error> for Box<dyn UError> {
     }
 }
 
+/// Enables the conversion from [`Result<T, nix::Error>`] to [`UResult<T>`].
+///
+/// # Examples
+///
+/// ```
+/// use uucore::error::FromIo;
+/// use nix::errno::Errno;
+///
+/// let nix_err = Err::<(), nix::Error>(Errno::EACCES);
+/// let uio_result = nix_err.map_err_context(|| String::from("fix me please!"));
+///
+/// // prints "fix me please!: Permission denied"
+/// println!("{}", uio_result.unwrap_err());
+/// ```
 impl<T> FromIo<UResult<T>> for Result<T, nix::Error> {
     fn map_err_context(self, context: impl FnOnce() -> String) -> UResult<T> {
         self.map_err(|e| {