Struct ChangeBuffer 

pub struct ChangeBuffer<T> { /* private fields */ }

A ChangeBuffer enables order-sensitive buffering of changes, and is meant to be used when traversing incremental revisions of a sphere. If changes are buffered in history order, they can be flushed and the flusher will be able to work with a flattened representation of all those changes.

Implementations

impl<T> ChangeBuffer<T>

pub fn new(capacity: usize) -> Self

Initialize a ChangeBuffer with the given capacity. When the capacity is reached, the ChangeBuffer must be flushed before additional changes are buffered.

pub fn is_full(&self) -> bool

Returns true if the ChangeBuffer is full

pub fn add(&mut self, key: String, value: T) -> Result<()>

Buffer an additive change by key

pub fn remove(&mut self, key: &str) -> Result<()>

Buffer a removal by key

pub fn take(&mut self) -> (BTreeMap<String, T>, BTreeSet<String>)

Take all the buffered, flattened changes. This has the effect of resetting the ChangeBuffer internally.

impl<R> ChangeBuffer<SphereFile<R>>

where R: AsyncFileBody + 'static,

pub async fn flush_to_writer(&mut self, writer: &SphereWriter) -> Result<()>

Flush the ChangeBuffer to a SphereWriter for the case where we are dealing in sphere content

impl ChangeBuffer<(Did, Cid)>

pub async fn flush_to_writer(&mut self, writer: &SphereWriter) -> Result<()>

Flush the ChangeBuffer to a SphereWriter for the case where we are dealing with peer references

Trait Implementations

impl<T: Debug> Debug for ChangeBuffer<T>

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

Formats the value using the given formatter.