Skip to main content

StreamFormat

Enum StreamFormat 

Source
pub enum StreamFormat {
    Json,
    NdJson,
    ServerSentEvents,
    Binary,
}
Expand description

Streaming format types

Variants§

§

Json

Standard JSON array streaming

§

NdJson

Newline-delimited JSON

§

ServerSentEvents

Server-Sent Events

§

Binary

Binary PJS protocol

Implementations§

Source§

impl StreamFormat

Source

pub fn from_accept_header(headers: &HeaderMap) -> Self

Picks a streaming format for the request’s Accept header.

Negotiation is RFC 9110 §12.5.1-conformant for this route’s supported media ranges, delegated to headers_accept::Accept::negotiate: candidates are ranked by q value first and by media-range specificity as the tiebreaker (exact match > application/* > */*).

  • q=0 is an explicit rejection of that media range and drops the entry.
  • A q parameter that is non-finite (nan/inf/-inf) or otherwise fails to parse as a float drops its entry — a malformed preference is treated as “no preference stated”, not “highest preference”. This is validated before delegating to headers_accept, whose own default treats an unparsable q as absent (i.e. 1.0, the highest priority) rather than dropping the entry.
  • A finite but out-of-range q (e.g. q=5) is clamped to [0.0, 1.0] and the entry is kept — matching the pre-migration hand-rolled parser’s .clamp(0.0, 1.0) exactly (not dropped; only q=0, non-finite, and unparsable q are dropped).
  • Wildcard matching is restricted to exactly */* and application/* (case-insensitive), which vote for Self::Json at their own q. Any other range containing a * (e.g. text/*, */x-ndjson) is rejected rather than delegated to headers_accept’s more general type/*/*/* matching, which is broader than this route’s historical, scoped wildcard support.
  • Each surviving entry is validated as a well-formed media type independently, before negotiation; a malformed entry (e.g. garbage!!) is dropped individually and does not discard the rest of the header — headers_accept::Accept::from_str itself fails the entire header on a single bad entry, so this crate is never handed anything but already-validated, surviving entries.
  • At most MAX_ACCEPT_ENTRIES (16) comma-separated entries are considered; any beyond that bound are silently ignored. This bound is enforced by truncating the raw header string before it reaches headers_accept’s parser, since that crate does not itself bound entry count.
  • A missing header, an unparsable header value, or no entry surviving negotiation all fall back to Self::Json.
Source

pub fn content_type(&self) -> &'static str

MIME type that corresponds to this streaming format.

Trait Implementations§

Source§

impl Clone for StreamFormat

Source§

fn clone(&self) -> StreamFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for StreamFormat

Source§

impl Debug for StreamFormat

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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