Struct elbus::FrameData

pub struct FrameData { /* private fields */ }

Implementations

impl FrameData

pub fn new(
    kind: FrameKind,
    sender: Option<String>,
    topic: Option<String>,
    header: Option<Vec<u8>>,
    buf: Vec<u8>,
    payload_pos: usize,
    realtime: bool
) -> Self

pub fn new_nop() -> Self

pub fn kind(&self) -> FrameKind

pub fn sender(&self) -> &str

Panics

Will panic if called for a prepared frame

pub fn topic(&self) -> Option<&str>

Filled for pub/sub communications

pub fn payload(&self) -> &[u8]

To keep zero-copy model, frames contain the full incoming buffer + actual payload position. Use this method to get the actual call payload.

pub fn header(&self) -> Option<&[u8]>

The header can be used by certain implementations (e.g. the default RPC layer) to keep zero-copy model. The header is None for IPC communications, but filled for inter-thread ones. A custom layer should use/parse the header to avoid unnecessary payload copy

pub fn is_realtime(&self) -> bool

Trait Implementations

impl Debug for FrameData

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

Formats the value using the given formatter.