Enum biome_formatter::BufferSnapshot

pub enum BufferSnapshot {
    Position(usize),
    Any(Box<dyn Any>),
}

Snapshot of a buffer state that can be restored at a later point.

Used in cases where the formatting of an object fails but a parent formatter knows an alternative strategy on how to format the object that might succeed.

Variants

Position(usize)

Stores an absolute position of a buffers state, for example, the offset of the last written element.

Any(Box<dyn Any>)

Generic structure for custom buffers that need to store more complex data. Slightly more expensive because it requires allocating the buffer state on the heap.

Implementations

impl BufferSnapshot

pub const fn position(index: usize) -> Self

Creates a new buffer snapshot that points to the specified position.

pub fn unwrap_position(&self) -> usize

Unwraps the position value.

Panics

If self is not a BufferSnapshot::Position

pub fn unwrap_any<T: 'static>(self) -> T

Unwraps the any value.

Panics

If self is not a BufferSnapshot::Any.

Trait Implementations

impl Debug for BufferSnapshot

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

Formats the value using the given formatter.