Struct BufferPolicy 

pub struct BufferPolicy { /* private fields */ }

Buffering contract for a stream: a bounded capacity plus an overflow rule.

A policy is always bounded with a capacity of at least one; the constructors reject a zero capacity. The overflow rule decides what happens when the buffer is full.

Examples

use sim_lib_stream_core::{BufferOverflowPolicy, BufferPolicy};

let policy = BufferPolicy::bounded(8).expect("capacity is nonzero");
assert_eq!(policy.capacity(), 8);
assert_eq!(policy.overflow(), BufferOverflowPolicy::DropNewest);
assert!(BufferPolicy::bounded(0).is_err());

Implementations

impl BufferPolicy

pub fn bounded(capacity: usize) -> Result<Self>

Builds a bounded policy of capacity with the default BufferOverflowPolicy::DropNewest overflow rule.

Returns an error if capacity is zero.

pub fn bounded_with_overflow( capacity: usize, overflow: BufferOverflowPolicy, ) -> Result<Self>

Builds a bounded policy of capacity with an explicit overflow rule.

Returns an error if capacity is zero.

pub fn capacity(&self) -> usize

Returns the buffer capacity.

pub fn overflow(&self) -> BufferOverflowPolicy

Returns the overflow rule.

pub fn symbol(&self) -> Symbol

Returns the stream/buffer/bounded-<capacity> symbol for this policy.

pub fn to_expr(&self) -> Expr

Encodes this policy as an Expr::Map with capacity and overflow fields.

pub fn from_expr(expr: &Expr) -> Result<Self>

Decodes a policy from an Expr::Map produced by to_expr.

Returns an error if the expression is not a map, a field is missing or the wrong type, or the capacity fails to parse.

Trait Implementations

impl Clone for BufferPolicy

fn clone(&self) -> BufferPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferPolicy

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

Formats the value using the given formatter.

impl Eq for BufferPolicy

impl PartialEq for BufferPolicy

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