Enum Frame 

pub enum Frame {
    Item(Vec<u8>),
    End,
    Error(PluginError),
}

One frame crossing the streaming boundary.

Item carries opaque payload bytes (the caller decides how to decode them — typically wire::deserialize::<T>() or a Value), so this type stays backend- and schema-neutral.

Variants

Item(Vec<u8>)

One streamed item; bytes are the bincode/Value payload.

End

Clean end of stream.

Error(PluginError)

Producer failed mid-stream; the stream terminates here.

Implementations

impl Frame

pub fn encode(&self) -> Result<Vec<u8>, WireError>

Encode this frame as [tag][len][payload].

pub fn decode(bytes: &[u8]) -> Result<Frame, FrameError>

Decode exactly one frame from bytes, which must contain a single frame and nothing more. Use Frame::read to pull one frame from a larger buffer and learn how many bytes were consumed.

pub fn read(bytes: &[u8]) -> Result<(Frame, usize), FrameError>

Read one frame from the front of bytes, returning the frame and the number of bytes consumed. Lets a decoder walk a buffer holding several concatenated frames (the cdylib next_batch / Value-rail path).

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<(), Error>

Formats the value using the given formatter.

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame