tokio_proto::streaming::multiplex

Enum Frame

pub enum Frame<T, B, E> {
    Message {
        id: RequestId,
        message: T,
        body: bool,
        solo: bool,
    },
    Body {
        id: RequestId,
        chunk: Option<B>,
    },
    Error {
        id: RequestId,
        error: E,
    },
}

Expand description

A multiplexed protocol frame

Variants§

Message

Either a request or a response.

Fields

§id: RequestId

Message exchange identifier

§message: T

The message value

§body: bool

Set to true when body frames will follow with the same request ID.

§solo: bool

Set to true when this message does not have a pair in the other direction

Body

Body frame.

Fields

§id: RequestId

Message exchange identifier

§chunk: Option<B>

Body chunk. Setting to None indicates that the body is done streaming and there will be no further body frames sent with the given request ID.

Error

Error

Fields

§id: RequestId

Message exchange identifier

§error: E

Error value

Implementations§

impl<T, B, E> Frame<T, B, E>

pub fn request_id(&self) -> RequestId

Return the request ID associated with the frame.

pub fn unwrap_msg(self) -> T

Unwraps a frame, yielding the content of the Message.

pub fn unwrap_body(self) -> Option<B>

Unwraps a frame, yielding the content of the Body.

pub fn unwrap_err(self) -> E

Unwraps a frame, yielding the content of the Error.

Trait Implementations§

impl<T: Clone, B: Clone, E: Clone> Clone for Frame<T, B, E>

fn clone(&self) -> Frame<T, B, E>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug, B: Debug, E: Debug> Debug for Frame<T, B, E>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T, B, E> Freeze for Frame<T, B, E>
where T: Freeze, E: Freeze, B: Freeze,

impl<T, B, E> RefUnwindSafe for Frame<T, B, E>
where T: RefUnwindSafe, E: RefUnwindSafe, B: RefUnwindSafe,

impl<T, B, E> Send for Frame<T, B, E>
where T: Send, E: Send, B: Send,

impl<T, B, E> Sync for Frame<T, B, E>
where T: Sync, E: Sync, B: Sync,

impl<T, B, E> Unpin for Frame<T, B, E>
where T: Unpin, E: Unpin, B: Unpin,

impl<T, B, E> UnwindSafe for Frame<T, B, E>
where T: UnwindSafe, E: UnwindSafe, B: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.