Struct trillium_api::ApiHandler

pub struct ApiHandler<F, OutputHandler, TryFromConn>(/* private fields */);

An interface layer built on trillium

This handler provides the capacity to extract various components of a conn such as deserializing a body, and supports returning handlers that will be called on the returned conn.

If ApiHandler encounters an error of any sort before the user-provided logic is executed, it will put an [Error] into the conn’s state. A default error handler is provided.

More documentation for this type is needed, hence the -rc semver on this crate

Implementations

impl<TryFromConnHandler, OutputHandler, Extracted> ApiHandler<TryFromConnHandler, OutputHandler, Extracted>

where TryFromConnHandler: for<'a> MutBorrowConn<'a, OutputHandler, Extracted>, OutputHandler: Handler, Extracted: TryFromConn,

pub fn new(api_handler: TryFromConnHandler) -> Self

constructs a new [ApiTryFromConnHandler] from the provided async fn(&mut conn, TryFromConn) -> impl Handler

Trait Implementations

impl<F: Debug, OutputHandler: Debug, TryFromConn: Debug> Debug for ApiHandler<F, OutputHandler, TryFromConn>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<TryFromConnHandler, OutputHandler, Extracted> From<TryFromConnHandler> for ApiHandler<TryFromConnHandler, OutputHandler, Extracted>

where TryFromConnHandler: for<'a> MutBorrowConn<'a, OutputHandler, Extracted>, OutputHandler: Handler, Extracted: TryFromConn,

fn from(value: TryFromConnHandler) -> Self

Converts to this type from the input type.

impl<TryFromConnHandler, OutputHandler, Extracted> Handler for ApiHandler<TryFromConnHandler, OutputHandler, Extracted>

where TryFromConnHandler: for<'a> MutBorrowConn<'a, OutputHandler, Extracted>, Extracted: TryFromConn, Extracted::Error: Handler, OutputHandler: Handler,

fn run<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement [Handler::upgrade]. The first handler that responds true to this will receive ownership of the [trillium::Upgrade][crate::Upgrade] in a subsequent call to [Handler::upgrade]

fn upgrade<'life0, 'async_trait>( &'life0 self, upgrade: Upgrade ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

This will only be called if the handler reponds true to [Handler::has_upgrade] and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, _info: &'life1 mut Info ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.