Struct tower_http::trace::TraceLayer

source ·
pub struct TraceLayer<M, MakeSpan = DefaultMakeSpan, OnRequest = DefaultOnRequest, OnResponse = DefaultOnResponse, OnBodyChunk = DefaultOnBodyChunk, OnEos = DefaultOnEos, OnFailure = DefaultOnFailure> { /* private fields */ }
Expand description

Layer that adds high level tracing to a Service.

See the module docs for more details.

Implementations§

source§

impl<M> TraceLayer<M>

source

pub fn new(make_classifier: M) -> Self
where M: MakeClassifier,

Create a new TraceLayer using the given MakeClassifier.

source§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

source

pub fn on_request<NewOnRequest>( self, new_on_request: NewOnRequest, ) -> TraceLayer<M, MakeSpan, NewOnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

Customize what to do when a request is received.

NewOnRequest is expected to implement OnRequest.

source

pub fn on_response<NewOnResponse>( self, new_on_response: NewOnResponse, ) -> TraceLayer<M, MakeSpan, OnRequest, NewOnResponse, OnBodyChunk, OnEos, OnFailure>

Customize what to do when a response has been produced.

NewOnResponse is expected to implement OnResponse.

source

pub fn on_body_chunk<NewOnBodyChunk>( self, new_on_body_chunk: NewOnBodyChunk, ) -> TraceLayer<M, MakeSpan, OnRequest, OnResponse, NewOnBodyChunk, OnEos, OnFailure>

Customize what to do when a body chunk has been sent.

NewOnBodyChunk is expected to implement OnBodyChunk.

source

pub fn on_eos<NewOnEos>( self, new_on_eos: NewOnEos, ) -> TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, NewOnEos, OnFailure>

Customize what to do when a streaming response has closed.

NewOnEos is expected to implement OnEos.

source

pub fn on_failure<NewOnFailure>( self, new_on_failure: NewOnFailure, ) -> TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, NewOnFailure>

Customize what to do when a response has been classified as a failure.

NewOnFailure is expected to implement OnFailure.

source

pub fn make_span_with<NewMakeSpan>( self, new_make_span: NewMakeSpan, ) -> TraceLayer<M, NewMakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

Customize how to make Spans that all request handling will be wrapped in.

NewMakeSpan is expected to implement MakeSpan.

source§

impl TraceLayer<HttpMakeClassifier>

source

pub fn new_for_http() -> Self

Create a new TraceLayer using ServerErrorsAsFailures which supports classifying regular HTTP responses based on the status code.

source§

impl TraceLayer<GrpcMakeClassifier>

source

pub fn new_for_grpc() -> Self

Create a new TraceLayer using GrpcErrorsAsFailures which supports classifying gRPC responses and streams based on the grpc-status header.

Trait Implementations§

source§

impl<M: Clone, MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnBodyChunk: Clone, OnEos: Clone, OnFailure: Clone> Clone for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

source§

fn clone( &self, ) -> TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

Returns a copy 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<M: Debug, MakeSpan: Debug, OnRequest: Debug, OnResponse: Debug, OnBodyChunk: Debug, OnEos: Debug, OnFailure: Debug> Debug for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

source§

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

Formats the value using the given formatter. Read more
source§

impl<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Layer<S> for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: Clone, MakeSpan: Clone, OnRequest: Clone, OnResponse: Clone, OnEos: Clone, OnBodyChunk: Clone, OnFailure: Clone,

§

type Service = Trace<S, M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

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.
source§

impl<M: Copy, MakeSpan: Copy, OnRequest: Copy, OnResponse: Copy, OnBodyChunk: Copy, OnEos: Copy, OnFailure: Copy> Copy for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>

Auto Trait Implementations§

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Freeze for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: Freeze, MakeSpan: Freeze, OnRequest: Freeze, OnResponse: Freeze, OnBodyChunk: Freeze, OnEos: Freeze, OnFailure: Freeze,

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> RefUnwindSafe for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: RefUnwindSafe, MakeSpan: RefUnwindSafe, OnRequest: RefUnwindSafe, OnResponse: RefUnwindSafe, OnBodyChunk: RefUnwindSafe, OnEos: RefUnwindSafe, OnFailure: RefUnwindSafe,

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Send for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: Send, MakeSpan: Send, OnRequest: Send, OnResponse: Send, OnBodyChunk: Send, OnEos: Send, OnFailure: Send,

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Sync for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: Sync, MakeSpan: Sync, OnRequest: Sync, OnResponse: Sync, OnBodyChunk: Sync, OnEos: Sync, OnFailure: Sync,

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> Unpin for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: Unpin, MakeSpan: Unpin, OnRequest: Unpin, OnResponse: Unpin, OnBodyChunk: Unpin, OnEos: Unpin, OnFailure: Unpin,

§

impl<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure> UnwindSafe for TraceLayer<M, MakeSpan, OnRequest, OnResponse, OnBodyChunk, OnEos, OnFailure>
where M: UnwindSafe, MakeSpan: UnwindSafe, OnRequest: UnwindSafe, OnResponse: UnwindSafe, OnBodyChunk: UnwindSafe, OnEos: UnwindSafe, OnFailure: UnwindSafe,

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§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

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

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

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

§

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>,

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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