Struct ServerFrame 

pub struct ServerFrame {
    pub version: u16,
    pub codec: Symbol,
    pub msg_id: Option<u64>,
    pub correlate: Option<u64>,
    pub kind: FrameKind,
    pub envelope: FrameEnvelope,
    pub payload: Vec<u8>,
}

A wire frame carrying a codec-encoded payload plus protocol metadata.

Fields

version: u16

Server frame format version.

codec: Symbol

Codec used to encode the payload.

msg_id: Option<u64>

Identifier of this message, if assigned.

correlate: Option<u64>

Message id this frame correlates to, if it is a reply.

kind: FrameKind

Role this frame plays in the protocol.

envelope: FrameEnvelope

Out-of-band envelope metadata.

payload: Vec<u8>

Codec-encoded payload bytes.

Implementations

impl ServerFrame

pub fn new( codec: Symbol, kind: FrameKind, envelope: FrameEnvelope, payload: Vec<u8>, ) -> Self

Builds a frame at the current version with no message or correlation id.

pub fn from_expr( cx: &mut Cx, codec: Symbol, kind: FrameKind, expr: &Expr, consistency: Consistency, required_capabilities: Vec<CapabilityName>, trace: bool, ) -> Result<Self>

Builds a frame by encoding expr under codec into the payload.

Seeds the envelope with the given consistency, required capabilities, and trace flag, leaving the remaining envelope fields at their defaults.

pub fn decode_expr(&self, cx: &mut Cx, read_policy: ReadPolicy) -> Result<Expr>

Decodes the payload back into an expression using the frame’s codec.

Trait Implementations

impl Clone for ServerFrame

fn clone(&self) -> ServerFrame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerFrame

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

Formats the value using the given formatter.

impl Eq for ServerFrame

impl Object for ServerFrame

fn display(&self, _cx: &mut Cx) -> Result<String>

Render the object as a human-readable display string.

fn as_any(&self) -> &dyn Any

Expose the object for Rust downcasting.

fn header(&self) -> &ObjectHeader

Identity and trust header for the object; defaults to the shared anonymous header.

fn op(&self, _key: &OpKey) -> Option<&dyn Op>

Resolve the operation registered under key, if any.

fn claims( &self, _cx: &mut Cx, _pattern: &ClaimPattern, _sink: &mut dyn ClaimSink, ) -> Result<(), Error>

Emit the object’s claims matching pattern into sink.

fn snapshot(&self, _cx: &mut Cx) -> Result<Option<Datum>, Error>

Optional content-addressable snapshot of the object’s state.

impl ObjectCompat for ServerFrame

fn class(&self, cx: &mut Cx) -> Result<ClassRef>

Class object this value belongs to; defaults to nil.

fn as_expr(&self, cx: &mut Cx) -> Result<Expr>

Expression form of the object; defaults to an opaque extension node.

fn as_table(&self, cx: &mut Cx) -> Result<Value>

Project the object into a table value; the default exposes its display.

fn as_callable(&self) -> Option<&dyn Callable>

Callable view, if the object can be invoked.

fn as_class(&self) -> Option<&dyn Class>

Class view, if the object is a class.

fn as_shape(&self) -> Option<&dyn Shape>

Shape view, if the object is a shape.

fn as_object_encoder(&self) -> Option<&dyn ObjectEncode>

Object-encoder view, if the object encodes other objects.

fn as_read_constructor(&self) -> Option<&dyn ReadConstructor>

Read-constructor view, if the object decodes data forms.

fn as_number_domain(&self) -> Option<&(dyn NumberDomain + 'static)>

Number-domain view, if the object is a number domain.

fn as_number_value(&self) -> Option<&dyn NumberValue>

Number-value view, if the object is a domain number.

fn as_eval_fabric(&self) -> Option<&dyn EvalFabric>

Eval-fabric view, if the object is a distributed eval surface.

fn as_stream(&self) -> Option<&dyn Stream>

Stream view, if the object is a stream.

fn as_sequence(&self) -> Option<&dyn Sequence>

Sequence view, if the object is a sequence.

fn as_thunk(&self) -> Option<&dyn Thunk>

Thunk view, if the object is a deferred computation.

fn as_list(&self) -> Option<&(dyn ListValue + 'static)>

List view, if the object is a list value.

fn as_table_impl(&self) -> Option<&(dyn Table + 'static)>

Table-implementation view, if the object is a table.

fn as_dir(&self) -> Option<&(dyn Dir + 'static)>

Directory view, if the object is a directory.

fn truth(&self, _cx: &mut Cx) -> Result<bool, Error>

Truthiness of the object; defaults to true.

fn publish_shape_satisfaction_claims( &self, _cx: &mut Cx, _shape: &Ref, ) -> Result<bool, Error>

Publish claims asserting that the object satisfies shape; returns whether any were published.

impl PartialEq for ServerFrame

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