Enum BufferStrategyKind 

#[repr(u8)]
pub enum BufferStrategyKind {
    PluginAllocated = 1,
    Arena = 2,
}

Buffer management strategy for an interface.

Selected per-trait via #[plugin_interface(buffer = ...)]. Determines the FFI function pointer signatures in the vtable.

Discriminant value 0 is reserved (previously CallerAllocated, removed in 0.1.0 — its value proposition was subsumed by PluginAllocated).

Variants

PluginAllocated = 1

Plugin allocates output; host frees via PluginDescriptor::free_buffer. VTable fns: (in_ptr, in_len, out_ptr, out_len) -> i32.

Arena = 2

Host provides a pre-allocated arena buffer; plugin writes its serialized output into the buffer. Returns STATUS_BUFFER_TOO_SMALL (with needed size written to out_len) if the arena is too small; host grows and retries. Data is valid only until the next call.

VTable fns: (in_ptr, in_len, arena_ptr, arena_cap, out_offset, out_len) -> i32.

Arena is allocation-avoidance, not zero-copy. The plugin still serializes its output (bincode-encoded by default) and copies the bytes into the host-provided buffer; what Arena saves is the per-call Box<[u8]> allocation that PluginAllocated incurs. For true byte passthrough — the bytes themselves cross the boundary without an encoding step — annotate the trait method with #[wire(raw)]. Raw wire mode composes with both buffer strategies.

Trait Implementations

impl Clone for BufferStrategyKind

fn clone(&self) -> BufferStrategyKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferStrategyKind

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

Formats the value using the given formatter.

impl Display for BufferStrategyKind

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

Formats the value using the given formatter.

impl PartialEq for BufferStrategyKind

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

impl Eq for BufferStrategyKind

impl StructuralPartialEq for BufferStrategyKind