Making Error type public so that consumers don't have to create their own type alias (#298)

coltonweaver · web-flow · commit 96fc5bce8543 · 2021-03-11T18:31:25.000-08:00
* Making Error type public so that consumers don't have to create their own type alias

* Missed usage in example

* Rust fmt changes

* Missed example use.

* Changing lambda_runtime::Error references to just Error and including in imports instead.
diff --git a/lambda-http/src/lib.rs b/lambda-http/src/lib.rs
@@ -17,9 +17,7 @@
 //! your function's execution path.
 //!
 //! ```rust,no_run
-//! use lambda_http::{handler, lambda_runtime};
-//!
-//! type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
+//! use lambda_http::{handler, lambda_runtime::{self, Error}};
 //!
 //! #[tokio::main]
 //! async fn main() -> Result<(), Error> {
@@ -36,9 +34,7 @@
 //! with the [`RequestExt`](trait.RequestExt.html) trait.
 //!
 //! ```rust,no_run
-//! use lambda_http::{handler, lambda_runtime::{self, Context}, IntoResponse, Request, RequestExt};
-//!
-//! type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
+//! use lambda_http::{handler, lambda_runtime::{self, Context, Error}, IntoResponse, Request, RequestExt};
 //!
 //! #[tokio::main]
 //! async fn main() -> Result<(), Error> {
@@ -66,8 +62,8 @@
 extern crate maplit;
 
 pub use http::{self, Response};
-use lambda_runtime::Handler as LambdaHandler;
 pub use lambda_runtime::{self, Context};
+use lambda_runtime::{Error, Handler as LambdaHandler};
 
 mod body;
 pub mod ext;
@@ -85,9 +81,6 @@ use std::{
     task::{Context as TaskContext, Poll},
 };
 
-/// Error type that lambdas may result in
-pub(crate) type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
-
 /// Type alias for `http::Request`s with a fixed [`Body`](enum.Body.html) type
 pub type Request = http::Request<Body>;
 
diff --git a/lambda-runtime/examples/basic.rs b/lambda-runtime/examples/basic.rs
@@ -1,15 +1,11 @@
 // This example requires the following input to succeed:
 // { "command": "do something" }
 
-use lambda_runtime::{handler_fn, Context};
+use lambda_runtime::{handler_fn, Context, Error};
 use log::LevelFilter;
 use serde::{Deserialize, Serialize};
 use simple_logger::SimpleLogger;
 
-/// A shorthand for `Box<dyn std::error::Error + Send + Sync + 'static>`
-/// type required by aws-lambda-rust-runtime.
-pub type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
-
 /// This is also a made-up example. Requests come into the runtime as unicode
 /// strings in json format, which can map to any structure that implements `serde::Deserialize`
 /// The runtime pays no attention to the contents of the request payload.
diff --git a/lambda-runtime/examples/error-handling.rs b/lambda-runtime/examples/error-handling.rs
@@ -1,14 +1,11 @@
 /// See https://github.com/awslabs/aws-lambda-rust-runtime for more info on Rust runtime for AWS Lambda
-use lambda_runtime::handler_fn;
+use lambda_runtime::{handler_fn, Error};
 use log::LevelFilter;
 use serde::{Deserialize, Serialize};
 use serde_json::{json, Value};
 use simple_logger::SimpleLogger;
 use std::fs::File;
 
-/// A shorthand for `Box<dyn std::error::Error + Send + Sync + 'static>` type required by aws-lambda-rust-runtime.
-pub type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
-
 /// A simple Lambda request structure with just one field
 /// that tells the Lambda what is expected of it.
 #[derive(Deserialize)]
diff --git a/lambda-runtime/src/lib.rs b/lambda-runtime/src/lib.rs
@@ -31,7 +31,7 @@ use requests::{EventCompletionRequest, EventErrorRequest, IntoRequest, NextEvent
 use types::Diagnostic;
 
 /// Error type that lambdas may result in
-pub(crate) type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
+pub type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
 
 /// Configuration derived from environment variables.
 #[derive(Debug, Default, Clone, PartialEq)]
