feat: add Result<T> type alias for `std::result::Result<T, tonic::S…

…tatus>` (#1085) * add `Result<T>` type alias for `std::result::Result<T, tonic::Status>` * Allow user to override the error type Co-authored-by: David Pedersen <[email protected]> * add rustdoc for `tonic::Result` * cargo fmt Co-authored-by: David Pedersen <[email protected]>
hyperium · Sep 26, 2022 · 56ff45d · 56ff45d
1 parent 3e40d81
commit 56ff45d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/tonic/src/lib.rs b/tonic/src/lib.rs
@@ -122,3 +122,7 @@ pub(crate) type Error = Box<dyn std::error::Error + Send + Sync>;
 #[cfg(feature = "codegen")]
 #[cfg_attr(docsrs, doc(cfg(feature = "codegen")))]
 pub mod codegen;
+
+/// `Result` is a type that represents either success ([`Ok`]) or failure ([`Err`]).
+/// By default, the Err value is of type [`Status`] but this can be overridden if desired.
+pub type Result<T, E = Status> = std::result::Result<T, E>;