Skip to main content

WireMessage

Enum WireMessage 

Source
pub enum WireMessage {
    Snapshot(SystemSnapshot),
    Heartbeat {
        server_version: String,
        uptime_secs: u64,
    },
    Error {
        code: u16,
        message: String,
    },
    Hello {
        client_version: String,
        auth_token: Option<String>,
    },
    Welcome {
        server_version: String,
        hostname: String,
        refresh_hz: u32,
    },
}
Expand description

Wire protocol messages exchanged between muxtop client and server.

Uses a custom Debug impl to redact auth_token in Hello messages, preventing accidental token leakage in logs or panic messages.

Variants§

§

Snapshot(SystemSnapshot)

Full system snapshot (server → client).

§

Heartbeat

Keepalive heartbeat (server → client).

Fields

§server_version: String
§uptime_secs: u64
§

Error

Error message (server → client).

Fields

§code: u16
§message: String
§

Hello

Client handshake (client → server).

Fields

§client_version: String
§auth_token: Option<String>
§

Welcome

Server handshake response (server → client).

Fields

§server_version: String
§hostname: String
§refresh_hz: u32

Implementations§

Source§

impl WireMessage

Source

pub fn encode_snapshot_ref(snap: &SystemSnapshot) -> Result<Frame, ProtoError>

Encode a SystemSnapshot into a Snapshot frame without taking ownership of the snapshot.

Per ADR-30-4 the relay path holds an Arc<SystemSnapshot> and needs to produce a single encoded Frame that it can then broadcast as bytes to every client task. Calling to_frame() would require constructing a WireMessage::Snapshot variant that owns the SystemSnapshot, which defeats the whole point of the Arc. This helper bypasses the wrapper and encodes directly from a borrow.

Source

pub fn to_frame(&self) -> Result<Frame, ProtoError>

Serialize this message into a Frame.

Source

pub fn from_frame(frame: &Frame) -> Result<Self, ProtoError>

Deserialize a Frame into a WireMessage.

Trait Implementations§

Source§

impl Clone for WireMessage

Source§

fn clone(&self) -> WireMessage

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 WireMessage

Source§

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

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

impl<'de> Deserialize<'de> for WireMessage

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for WireMessage

Source§

fn eq(&self, other: &WireMessage) -> 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 Serialize for WireMessage

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for WireMessage

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,