Struct StreamContext 

#[non_exhaustive]
pub struct StreamContext {
    pub format: Cow<'static, str>,
    pub direction: Direction,
    pub side: Side,
    pub status: Option<u16>,
    pub content_length: Option<u64>,
    pub content_type: Option<String>,
    pub max_obj_len: Option<usize>,
    pub buf_capacity: Option<usize>,
}

What a stream is about, for the span covering it.

Fields the caller cannot know are simply left None and are omitted from the span rather than reported as a placeholder.

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.

format: Cow<'static, str>

The format’s format_name.

Cow rather than &'static str because axum-streams’ long-standing public StreamingFormat::format_name returns a borrowed &str, and that signature cannot change without breaking the third-party implementations it was made public for. Core’s own formats all return &'static str and so allocate nothing.

direction: Direction

Request or response body.

side: Side

Client or server.

status: Option<u16>

Response status, where one is known.

content_length: Option<u64>

Declared body length, where one is known.

content_type: Option<String>

The negotiated content type, where one is known.

max_obj_len: Option<usize>

The per-object limit in force, where one applies.

buf_capacity: Option<usize>

The read-buffer size in force, where one applies.

Implementations

impl StreamContext

pub fn new( format: impl Into<Cow<'static, str>>, direction: Direction, side: Side, ) -> Self

A context for format, in the given direction and on the given side.

pub fn status(self, status: u16) -> Self

Record the response status.

pub fn content_length(self, len: Option<u64>) -> Self

Record the declared body length.

pub fn content_type(self, ct: impl Into<String>) -> Self

Record the content type.

pub fn max_obj_len(self, len: usize) -> Self

Record the per-object limit.

pub fn buf_capacity(self, cap: usize) -> Self

Record the read-buffer size.

Trait Implementations

impl Clone for StreamContext

fn clone(&self) -> StreamContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamContext

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

Formats the value using the given formatter.

impl Default for StreamContext

fn default() -> StreamContext

Returns the “default value” for a type.