Struct Context

#[non_exhaustive]
pub struct Context {
    pub deadline: SystemTime,
    pub discard_response: bool,
    pub trace_context: Context,
}

A request context that carries request-scoped information like deadlines and trace information. It is sent from client to server and is used by the server to enforce response deadlines.

The context should not be stored directly in a server implementation, because the context will be different for each request in scope.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

deadline: SystemTime

When the client expects the request to be complete by. The server should cancel the request if it is not complete by this time.

discard_response: bool

A client might not care about response at all, in this case server must discard reponse object

trace_context: Context

Uniquely identifies requests originating from the same source. When a service handles a request by making requests itself, those requests should include the same trace_id as that included on the original request. This way, users can trace related actions across a distributed system.

Implementations

impl Context

pub fn current() -> Self

Returns the context for the current request, or a default Context if no request is active.

pub fn trace_id(&self) -> &TraceId

Returns the ID of the request-scoped trace.

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Context

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Context

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Context