Skip to main content

Appender

Struct Appender 

Source
pub struct Appender { /* private fields */ }
Expand description

Append-only transcript authority.

Every method consumes an owned candidate before taking the commit lock. No user clone or callback runs while the write lock is held; after all checks, the ordered batch and version become visible in one critical section.

ⓘ
use reef_core::transcript::store;
let append = store::Store::new().appender();
append.replace(Vec::new());

Implementations§

Source§

impl Appender

Source

pub fn append(&self, item: Item) -> Result<Version, Error>

Appends one owned item and advances the version by one.

§Errors

Error::VersionOverflow if the store already stands at Version::MAX, and Error::Poisoned if a writer panicked while holding the store lock. Either way the history is unchanged. There is no conflict to report, because this append accepts whatever version it finds.

Source

pub fn append_batch(&self, items: Vec<Item>) -> Result<Version, Error>

Atomically appends an owned ordered batch.

The version advances by items.len(). An empty batch is a successful no-op which still reports lock poisoning.

§Errors

Error::VersionOverflow, reporting the current version and the requested increment, if advancing by items.len() would pass Version::MAX; and Error::Poisoned if a writer panicked while holding the store lock. A failure appends none of the batch — this is the atomicity the whole crate’s “never write half of an exchange” rule rests on, so a rejected batch leaves no partial history behind.

Source

pub fn append_batch_if_version( &self, items: Vec<Item>, expected: Version, ) -> Result<Version, Error>

Atomically appends a batch only at expected.

Even an empty batch checks expected; conflicts and overflow leave both history and version unchanged.

§Errors
  • Error::VersionConflict, reporting both expected and the version actually observed under the commit lock, if another writer advanced the store after the caller read expected. The concurrent winner is never overwritten; the loser is expected to re-read and decide again.
  • Error::VersionOverflow if the batch would advance past Version::MAX. The conflict check runs first, so a stale caller hears about staleness rather than about a limit it may not be near.
  • Error::Poisoned if a writer panicked while holding the store lock.

Trait Implementations§

Source§

impl Clone for Appender

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Appender

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.