Struct EventStreamFraming 

#[non_exhaustive]
pub struct EventStreamFraming<'a> {
    pub payload_codec: &'a dyn DynCodec,
    pub media_type: &'a str,
    pub initial_messages_in_frames: bool,
    pub unset_initial_response_payload: &'static [u8],
    pub exception_discriminator: Option<BodyDiscriminator>,
    pub exception_http_bindings: bool,
    pub xml_exception_codec: Option<&'a dyn DynCodec>,
    pub xml_exceptions_wrapped: bool,
}

The event-frame capability of a metadata-routed protocol, as plain data.

Answered by MetadataRoutedProtocol::event_stream_framing; a protocol that does not support event streams answers None. Body-routed protocols cannot express this at all: body-first routing collects the body before selecting an operation, and an event-stream body must not be collected.

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.

payload_codec: &'a dyn DynCodec

Codec for structured event and initial-message payloads.

media_type: &'a str

Media type of structured event payloads.

initial_messages_in_frames: bool

Whether non-stream members travel in initial-message frames.

This controls their payload and initial-request handling, not whether an explicitly requested initial-response frame is emitted.

unset_initial_response_payload: &'static [u8]

Initial-response payload when non-stream members travel in HTTP bindings instead.

Used when initial_messages_in_frames is false. Generated serde REST JSON sends {}; REST XML sends zero bytes.

exception_discriminator: Option<BodyDiscriminator>

Optional body discriminator for modeled exception frames.

exception_http_bindings: bool

Whether HTTP-bound exception members are excluded from the frame payload.

xml_exception_codec: Option<&'a dyn DynCodec>

Codec for received exception frames that carry a REST XML error envelope, as generated serde restXml servers expect. The codec reads the <Error> element without validating its root name.

xml_exceptions_wrapped: bool

With xml_exception_codec: whether the <Error> element is wrapped in <ErrorResponse> (the default) or is the root (@restXml(noErrorWrapping: true)).

Implementations

impl<'a> EventStreamFraming<'a>

pub fn new(payload_codec: &'a dyn DynCodec, media_type: &'a str) -> Self

Framing with the given payload codec and media type; non-stream members do not travel in initial-message frames unless initial_messages_in_frames is set.

pub fn xml_exceptions(self, codec: &'a dyn DynCodec, wrapped: bool) -> Self

Reads received exception frames from a REST XML error envelope with codec, which must not validate the root element name: <ErrorResponse><Error>..</Error></ErrorResponse> when wrapped, otherwise <Error>..</Error>.

pub fn exception_discriminator(self, discriminator: BodyDiscriminator) -> Self

Sets the body discriminator used for modeled exception payloads.

pub fn exception_http_bindings(self, enabled: bool) -> Self

Applies REST error-body bindings to structured exception payloads.

pub fn initial_messages_in_frames( self, initial_messages_in_frames: bool, ) -> Self

Sets whether non-stream members travel in initial-message frames.

pub fn unset_initial_response_payload(self, payload: &'static [u8]) -> Self

Sets the initial-response payload for protocols whose non-stream members use HTTP bindings. Defaults to zero bytes; ignored when initial messages carry output members.

Trait Implementations

impl<'a> Clone for EventStreamFraming<'a>

fn clone(&self) -> EventStreamFraming<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EventStreamFraming<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for EventStreamFraming<'a>