RequestLoggerLayer

Struct RequestLoggerLayer 

Source
pub struct RequestLoggerLayer { /* private fields */ }
Expand description

Tower layer for the request logging middleware.

This is the main entry point for using the outlet middleware. It implements the Tower Layer trait and can be used with Axum’s layering system.

The layer spawns a background task to process captured request/response data using the provided RequestHandler.

§Examples

use outlet::{RequestLoggerLayer, RequestLoggerConfig, LoggingHandler};
use axum::{routing::get, Router};
use tower::ServiceBuilder;

let config = RequestLoggerConfig::default();
let handler = LoggingHandler;
let layer = RequestLoggerLayer::new(config, handler);

let app = Router::new()
    .route("/hello", get(hello))
    .layer(ServiceBuilder::new().layer(layer));

let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
axum::serve(listener, app).await.unwrap();

Implementations§

Source§

impl RequestLoggerLayer

Source

pub fn new<H: RequestHandler>(config: RequestLoggerConfig, handler: H) -> Self

Create a new request logger layer with the given configuration and handler.

This spawns a background task that will process captured request/response data using the provided handler.

§Arguments
  • config - Configuration controlling what data to capture
  • handler - Implementation of RequestHandler to process the captured data
§Examples
use outlet::{RequestLoggerLayer, RequestLoggerConfig, LoggingHandler};

let config = RequestLoggerConfig {
    capture_request_body: true,
    capture_response_body: true,
};
let handler = LoggingHandler;

// Spawns the background task that runs the provided handler
let layer = RequestLoggerLayer::new(config, handler);

// use the layer anywhere you'd use a tower layer, and your handler will be called (in the
// background) as each request traverses the layer.

Trait Implementations§

Source§

impl Clone for RequestLoggerLayer

Source§

fn clone(&self) -> RequestLoggerLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<S> Layer<S> for RequestLoggerLayer

Source§

type Service = RequestLoggerService<S>

The wrapped service
Source§

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,