chore: prepare to publish

Cargo.toml

@@ -5,11 +5,19 @@ authors = ["loichyan <loichyan@foxmail.com>"]
 edition = "2018"
 license = "MIT"
 
+description = "Easily create error with contexts"
+readme = "README.md"
+repository = "https://github.com/loichyan/thisctx"
+documentation = "https://docs.rs/thisctx"
+
+keywords = ["error"]
+categories = ["rust-patterns"]
+
 [workspace]
 members = ["impl"]
 
 [dependencies]
-thisctx_impl = { path = "impl" }
+thisctx_impl = { version="=0.1.0", path="impl" }
 
 [dev-dependencies]
 thiserror = "1.0"

README.md

@@ -1,54 +1,34 @@
 # THISCTX
 
-A simple crate work with [thiserror](https://crates.io/crates/thiserror) to create errors with contexts, inspired by [snafu](https://crates.io/crates/snafu);
+A simple crate work with [thiserror](https://crates.io/crates/thiserror) to create errors with contexts, inspired by [snafu](https://crates.io/crates/snafu).
 
 ## Examples
 
 ```rust
-use thisctx::thisctx;
+use std::fs;
+use std::path::{Path, PathBuf};
+use thisctx::{thisctx, ResultExt};
 use thiserror::Error;
 
 thisctx! {
     #[derive(Debug, Error)]
     pub enum Error {
-        #[error("I/O failed '{}': {src}", .ctx.path.display())]
+        #[error("I/O failed '{}': {src}", .ctx.0.display())]
         IoFaild {
             #[source]
             @source
             src: std::io::Error,
             @context
             ctx:
                 #[derive(Debug)]
-                struct {
-                    path: std::path::PathBuf,
-                },
+                struct (PathBuf),
         },
-        #[error("invalid file '{}': {}", .ctx.path.display(), .ctx.disc)]
-        InvalidFile {
-            @context
-            ctx:
-                #[derive(Debug)]
-                struct {
-                    disc: String,
-                    path: std::path::PathBuf,
-                },
-        },
-        #[error("not UTF-8: {0}")]
-        NotUtf8 (
-            #[source]
-            @source
-            std::str::Utf8Error
-        ),
-        #[error("invalid argument: '{}'", 0.0)]
-        InvalidArg (
-            @context
-            #[derive(Debug)]
-            struct (String)
-        ),
-        #[error("I have no idea about this error")]
-        JustFailed,
     }
 }
+
+fn load_config(path: &Path) -> Result<String, Error> {
+    fs::read_to_string(path).context(IoFaild(path))
+}
 ```
 
 ## License

src/lib.rs

@@ -1,3 +1,34 @@
+//! A simple crate work with [thiserror](https://crates.io/crates/thiserror) to create errors with contexts, inspired by [snafu](https://crates.io/crates/snafu).
+//!
+//! # Examples
+//!
+//! ```rust
+//! use std::fs;
+//! use std::path::{Path, PathBuf};
+//! use thisctx::{thisctx, ResultExt};
+//! use thiserror::Error;
+//!
+//! thisctx! {
+//! 	#[derive(Debug, Error)]
+//! 	pub enum Error {
+//! 		#[error("I/O failed '{}': {src}", .ctx.0.display())]
+//! 		IoFaild {
+//! 			#[source]
+//! 			@source
+//! 			src: std::io::Error,
+//! 			@context
+//! 			ctx:
+//! 				#[derive(Debug)]
+//! 				struct (PathBuf),
+//! 		},
+//!    }
+//! }
+//!
+//! fn load_config(path: &Path) -> Result<String, Error> {
+//! 	fs::read_to_string(path).context(IoFaild(path))
+//! }
+//!```
+
 mod ext;
 
 pub use ext::{IntoError, NoneError, OptionExt, ResultExt};

tests/use_macro.rs

@@ -48,8 +48,8 @@ thisctx! {
             struct (String)
         ),
         #[error("I have no idea about this error")]
-        JustFailed { },
+        JustFailed {},
         #[error("it just failed either")]
-        FailedEither ( ),
+        FailedEither (),
     }
 }