Enum StreamFraming 

#[non_exhaustive]
pub enum StreamFraming {
    ServerSentEvents,
    MultipartMixed,
}

Wire framing for a server-streaming HTTP binding.

Two framings at two paths are two operations, not variants of one — this selects which wire format a single streaming binding speaks, not a content-negotiation set.

#[non_exhaustive] is safe here (unlike HttpMethodBindingIr, which the macro emits as a struct literal): #[toolkit::rest_contract] only ever emits a variant path of this enum, which #[non_exhaustive] permits.

Default is Self::ServerSentEvents so IR serialized before a framing selector existed deserializes to the historical behavior.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ServerSentEvents

text/event-stream — W3C Server-Sent Events. The historical default.

MultipartMixed

multipart/mixed — one JSON item per body part.

Implementations

impl StreamFraming

pub const ALL: &'static [StreamFraming]

Every framing variant, in declaration order.

Lets consumers derive the set of streaming media types from the enum (via media_type) instead of hard-coding the strings — e.g. the OpenAPI registry deciding which response media types carry a JSON item schema rather than an opaque string. Kept complete by the exhaustiveness guard below, so a new variant cannot be silently omitted.

pub const fn media_type(self) -> &'static str

The media type the client advertises in Accept and the server emits in Content-Type.

For multipart/mixed the emitted header additionally carries a runtime-generated boundary= parameter, which is not part of this value — see toolkit::http::multipart::MultipartJsonStream.

pub fn is_stream_media_type(media_type: &str) -> bool

Whether media_type is the media type of some streaming framing.

Derived from ALL so a new framing is included automatically; the OpenAPI registry uses it to decide whether a response media type renders its schema as a $ref (streaming JSON item) rather than an opaque string.

Trait Implementations

impl Clone for StreamFraming

fn clone(&self) -> StreamFraming

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamFraming

impl Debug for StreamFraming

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

Formats the value using the given formatter.

impl Default for StreamFraming

fn default() -> StreamFraming

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StreamFraming

fn deserialize<__D>( __deserializer: __D, ) -> Result<StreamFraming, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for StreamFraming

impl PartialEq for StreamFraming

fn eq(&self, other: &StreamFraming) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for StreamFraming

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamFraming