Struct BufferStore 

pub struct BufferStore { /* private fields */ }

Server-wide buffer store.

Buffers are server-global state, not session-keyed. Unnamed buffers use deterministic names (buffer0, buffer1, …) from a monotonically increasing sequence. The allocator skips names already occupied by existing buffers, including explicit named buffers. FIFO eviction at the effective buffer-limit removes only unnamed buffers.

Implementations

impl BufferStore

pub fn new() -> Self

Creates an empty buffer store.

pub fn len(&self) -> usize

Returns the number of buffers currently stored.

pub fn is_empty(&self) -> bool

Returns whether the store contains no buffers.

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

Returns the name of the stack-head buffer (most recently created/replaced).

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

Returns the name of the most recent automatic buffer.

pub fn get(&self, name: &str) -> Option<&[u8]>

Returns the content of the named buffer, or None if it does not exist.

pub fn set( &mut self, name: Option<&str>, content: Vec<u8>, buffer_limit: usize, ) -> Result<SetBufferOutcome, RmuxError>

Sets a named buffer, replacing it if it already exists.

When name is Some, the buffer is created or replaced with that name. When name is None, a new unnamed buffer is created with the next deterministic name.

Zero-length content succeeds without creating or replacing any buffer.

Returns a list of buffer names evicted by FIFO unnamed eviction (may be empty), followed by the optional name of the created/replaced buffer.

pub fn rename( &mut self, old_name: Option<&str>, new_name: &str, ) -> Result<RenameBufferOutcome, RmuxError>

Renames a buffer, replacing any existing destination buffer.

pub fn delete(&mut self, name: Option<&str>) -> Result<String, RmuxError>

Deletes a buffer by name.

When name is None, deletes the most recent automatic buffer. Returns the name of the deleted buffer.

pub fn delete_if_order_matches(&mut self, name: &str, order: u64) -> bool

Deletes a buffer only when the current entry still matches order.

Returns true when the matching entry was removed. Returns false when the buffer is absent or has since been replaced.

pub fn show(&self, name: Option<&str>) -> Result<(&str, &[u8]), RmuxError>

Returns the content of a buffer by name, or the most recent automatic buffer when name is None.

pub fn show_with_order( &self, name: Option<&str>, ) -> Result<(&str, &[u8], u64), RmuxError>

Returns the content and current replacement order for a buffer.

pub fn entries(&self) -> Vec<BufferView<'_>>

Returns immutable buffer entries for server-side formatting and sorting.

pub fn list(&self) -> Vec<String>

Returns a formatted listing of all buffers, ordered by most recent first.

Trait Implementations

impl Clone for BufferStore

fn clone(&self) -> BufferStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferStore

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

Formats the value using the given formatter.

impl Default for BufferStore

fn default() -> BufferStore

Returns the “default value” for a type.