Struct Frame 

#[non_exhaustive]
pub struct Frame<C, T = Value>
where
    C: ChannelKind,
{
    pub channel: C,
    pub cursor: Option<u64>,
    pub payload: T,
    pub client_id: Option<Uuid>,
}

Envelope for multiplexed frames. Payloads are intentionally generic so downstream services can attach their own typed content.

C is the channel type (implements ChannelKind). T is the payload type (defaults to serde_json::Value).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

channel: C

cursor: Option<u64>

payload: T

client_id: Option<Uuid>

Implementations

impl<C, T> Frame<C, T>

where C: ChannelKind,

pub fn new(channel: C, payload: T) -> Frame<C, T>

pub fn with_cursor(self, cursor: u64) -> Frame<C, T>

pub fn with_client(self, client_id: Uuid) -> Frame<C, T>

Trait Implementations

impl<C, T> Clone for Frame<C, T>

where C: Clone + ChannelKind, T: Clone,

fn clone(&self) -> Frame<C, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, T> Debug for Frame<C, T>

where C: Debug + ChannelKind, T: Debug,

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

Formats the value using the given formatter.

impl<'de, C, T> Deserialize<'de> for Frame<C, T>

where C: ChannelKind, T: DeserializeOwned,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Frame<C, T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C, T> Serialize for Frame<C, T>

where C: ChannelKind, T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.