Struct Frame 

#[non_exhaustive]
pub struct Frame {
    pub bytes: Vec<u8>,
    pub kind: FrameKind,
    pub seq: Option<u64>,
    pub frame_type: String,
    pub correlation_id: Option<String>,
}

Single stream frame appended via append_frame (RFC-012 §3.3.0). Today’s FCALL takes the byte payload + frame_type + optional seq as discrete ARGV; Stage 0 collects them into a named type for trait signatures.

Round-7 follow-up (PR #145 → #146): extended with frame_type: String (the SDK-public free-form classifier — values like "delta", "log", "agent_step", "summary_token", "transcribe_line", "progress" — distinct from the coarse FrameKind enum) and correlation_id: Option<String> (the wire-level correlation_id ARGV, surfaced at the SDK as metadata: Option<&str>). Adding these lets ClaimedTask::append_frame forward through the trait without wire-parity regression.

frame_type is free-form and is what the backend writes into the Lua-side frame_type ARGV. FrameKind remains for typed classification at the trait surface; when callers populate only kind, the backend falls back to a stable encoding of the enum variant (see frame_kind_to_str in ff-backend-valkey).

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.

bytes: Vec<u8>

kind: FrameKind

seq: Option<u64>

Optional monotonic sequence. Set by the caller when the stream protocol is sequence-bound; None lets the backend assign.

frame_type: String

Free-form classifier written to the Lua-side frame_type ARGV. Empty string means “defer to FrameKind” — the backend substitutes the enum-variant encoding.

correlation_id: Option<String>

Optional correlation id (wire correlation_id ARGV). None encodes as the empty string on the wire.

Implementations

impl Frame

pub fn new(bytes: Vec<u8>, kind: FrameKind) -> Self

Construct a frame. seq defaults to None (backend-assigned); frame_type defaults to empty (backend falls back to FrameKind encoding); correlation_id defaults to None. Callers that need an explicit sequence use Frame::with_seq; callers on the SDK forwarder path populate frame_type + correlation_id via Frame::with_frame_type / Frame::with_correlation_id.

pub fn with_seq(bytes: Vec<u8>, kind: FrameKind, seq: u64) -> Self

Construct a frame with an explicit monotonic sequence.

pub fn with_frame_type(self, frame_type: impl Into<String>) -> Self

Builder-style setter for the free-form frame_type classifier.

pub fn with_correlation_id(self, correlation_id: impl Into<String>) -> Self

Builder-style setter for the optional correlation_id.

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 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 Eq for Frame

impl StructuralPartialEq for Frame