Skip to main content

MsgKind

Enum MsgKind 

Source
#[repr(u8)]
pub enum MsgKind { Hello = 1, HelloAck = 2, Input = 3, Output = 4, Resize = 5, ResizeAck = 6, Exit = 10, Shutdown = 11, Ping = 12, Pong = 13, Error = 127, }
Expand description

Message types in the keepty protocol.

Variants§

§

Hello = 1

Client handshake. Payload: [role: u8, cols: u16 BE, rows: u16 BE]

§

HelloAck = 2

Broker acknowledgement. Payload: [pty_pid: u32 BE, cols: u16 BE, rows: u16 BE]

§

Input = 3

Raw keystroke data from client to PTY. Payload: raw bytes.

§

Output = 4

Raw PTY output bytes broadcast to all clients. Payload: raw bytes.

§

Resize = 5

Terminal resize. Payload: [cols: u16 BE, rows: u16 BE]

§

ResizeAck = 6

Broker acknowledgement of resize. Payload: [resize_gen: u32 BE, cols: u16 BE, rows: u16 BE] Broadcast to all clients after the broker applies the resize to the PTY. Acts as an in-band fence: output before this was old geometry.

§

Exit = 10

Process exit. Payload: [exit_code: i32 BE]

§

Shutdown = 11

Request graceful shutdown.

§

Ping = 12

Connection keepalive (client -> broker).

§

Pong = 13

Keepalive response (broker -> client).

§

Error = 127

Error message. Payload: UTF-8 error string.

Trait Implementations§

Source§

impl Clone for MsgKind

Source§

fn clone(&self) -> MsgKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MsgKind

Source§

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

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

impl PartialEq for MsgKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl TryFrom<u8> for MsgKind

Source§

type Error = u8

The type returned in the event of a conversion error.
Source§

fn try_from(v: u8) -> Result<Self, u8>

Performs the conversion.
Source§

impl Copy for MsgKind

Source§

impl Eq for MsgKind

Source§

impl StructuralPartialEq for MsgKind

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