Enum WireFrame 

pub enum WireFrame {
    Heartbeat(Heartbeat),
    Request {
        id: RequestId,
        body: LocalRequest,
    },
    Response {
        id: RequestId,
        body: LocalResponse,
    },
    Event {
        topic: String,
        payload: Vec<u8>,
    },
    Goodbye,
}

One frame on the wire. All inter-process communication on the local link is one or more of these.

Variants

Heartbeat(Heartbeat)

Cheap keepalive. Either side sends; receiver echoes the same nonce back as another Heartbeat. Failure to receive the echo within N seconds (caller-configurable) terminates the link.

Request

CLI → daemon request.

Fields

id: RequestId

body: LocalRequest

Response

Daemon → CLI response (correlates to a prior Request.id).

Fields

id: RequestId

body: LocalResponse

Event

Daemon → CLI event push. id is always 0.

Fields

topic: String

payload: Vec<u8>

Goodbye

Graceful shutdown signal. Either side may send; the receiver drains pending responses then closes the connection.

Trait Implementations

impl Archive for WireFrame

where Heartbeat: Archive, RequestId: Archive, LocalRequest: Archive, LocalResponse: Archive, String: Archive, Vec<u8>: Archive,

type Archived = ArchivedWireFrame

The archived representation of this type.

type Resolver = WireFrameResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve( &self, resolver: <Self as Archive>::Resolver, out: Place<<Self as Archive>::Archived>, )

Creates the archived version of this value at the given position and writes it to the given output.

const COPY_OPTIMIZATION: CopyOptimization<Self> = _

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

impl Clone for WireFrame

fn clone(&self) -> WireFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WireFrame

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<WireFrame, __D> for Archived<WireFrame>

where Heartbeat: Archive, <Heartbeat as Archive>::Archived: Deserialize<Heartbeat, __D>, RequestId: Archive, <RequestId as Archive>::Archived: Deserialize<RequestId, __D>, LocalRequest: Archive, <LocalRequest as Archive>::Archived: Deserialize<LocalRequest, __D>, LocalResponse: Archive, <LocalResponse as Archive>::Archived: Deserialize<LocalResponse, __D>, String: Archive, <String as Archive>::Archived: Deserialize<String, __D>, Vec<u8>: Archive, <Vec<u8> as Archive>::Archived: Deserialize<Vec<u8>, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<WireFrame, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl PartialEq for WireFrame

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<__S: Fallible + ?Sized> Serialize<__S> for WireFrame

where Heartbeat: Serialize<__S>, RequestId: Serialize<__S>, LocalRequest: Serialize<__S>, LocalResponse: Serialize<__S>, String: Serialize<__S>, Vec<u8>: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

impl StructuralPartialEq for WireFrame