Struct Frame 

pub struct Frame {
    pub topic: String,
    pub id: Scru128Id,
    pub hash: Option<Integrity>,
    pub meta: Option<Value>,
    pub ttl: Option<TTL>,
}

A single event in the stream.

A frame is metadata; the payload bytes (if any) live in the content-addressed store and are referenced by hash. Build one with the bon builder, where the topic is the required starting argument:

use xs::{Frame, TTL};

let frame = Frame::builder("clip.add")
    .meta(serde_json::json!({ "source": "keyboard" }))
    .ttl(TTL::Last(100))
    .build();

assert_eq!(frame.topic, "clip.add");

The id is assigned by Store::append at write time, so the value you set on a builder is ignored when appending.

Fields

topic: String

Dot-delimited topic this frame belongs to (for example clip.add).

Must satisfy validate_topic; Store::append rejects invalid topics.

id: Scru128Id

Time-sortable identifier. Assigned by Store::append; any value set before appending is overwritten.

hash: Option<Integrity>

Integrity hash of the payload in the content-addressed store, if this frame has one. Produce it with Store::cas_insert.

meta: Option<Value>

Arbitrary JSON metadata carried inline with the frame.

ttl: Option<TTL>

Retention policy for this frame. Defaults to TTL::Forever when unset.

Implementations

impl Frame

pub fn builder(topic: impl Into<String>) -> FrameBuilder

Create an instance of Frame using the builder syntax

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Frame

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Frame

impl PartialEq for Frame

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Frame