Skip to main content

Frame

Enum Frame 

Source
pub enum Frame {
    Input(Vec<u8>),
    Resize {
        cols: u16,
        rows: u16,
    },
    Ping,
    Detach,
    End,
    Output {
        offset: u64,
        data: Vec<u8>,
    },
    Lost {
        from: u64,
        to: u64,
    },
    Exited {
        code: i32,
    },
    Pong,
    Hello {
        session: String,
        created: bool,
        end: u64,
    },
    Error(String),
}
Expand description

One message.

Variants§

§

Input(Vec<u8>)

Keystrokes for the session’s terminal.

§

Resize

The pane’s size.

Fields

§cols: u16
§rows: u16
§

Ping

Are you there? Answered with Pong; silence means a stalled link (§7.5).

§

Detach

Leave the session running and drop this connection.

§

End

End the session: its shell and everything it started.

§

Output

Terminal output starting at byte offset of the session’s stream.

Fields

§offset: u64
§data: Vec<u8>
§

Lost

Bytes from..to fell out of the session’s ring before they could be replayed: the pane marks a gap there.

Fields

§from: u64
§to: u64
§

Exited

The session’s shell exited with code; the session is over.

Fields

§code: i32
§

Pong

§

Hello

Sent first: the session id, whether it was just created, and the next offset its output will have.

Fields

§session: String
§created: bool
§end: u64
§

Error(String)

Something went wrong, in words for the pane.

Implementations§

Source§

impl Frame

Source

pub fn encode(&self) -> Vec<u8> ⓘ

The frame’s bytes on the wire.

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

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 Debug for Frame

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Frame

Source§

impl PartialEq for Frame

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnsafeUnpin for Frame

§

impl UnwindSafe for Frame

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<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, 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> 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.