Struct bookkeeper_client::LedgerReader

pub struct LedgerReader { /* private fields */ }

Ledger reader.

Implementations

impl LedgerReader

pub fn id(&self) -> LedgerId

Returns ledger id.

pub fn last_add_confirmed(&self) -> EntryId

Gets local cached last_add_confirmed which could vary due to concurrent read and write.

pub async fn read( &self, first_entry: EntryId, last_entry: EntryId, options: Option<&ReadOptions> ) -> Result<Vec<Vec<u8>>, Error<ErrorKind>>

Reads entries from first_entry to last_entry.

pub async fn poll( &self, entry_id: EntryId, options: &PollOptions ) -> Result<Vec<u8>, Error<ErrorKind>>

Polls entry with given id.

Cautions

• Ledger closing will not interrupt this operation.

pub async fn read_last_add_confirmed( &self, options: &LacOptions ) -> Result<EntryId, Error<ErrorKind>>

Reads last_add_confirmed from latest ensemble.

pub async fn read_unconfirmed( &self, first_entry: EntryId, last_entry: EntryId, options: Option<&ReadOptions> ) -> Result<Vec<Vec<u8>>, Error<ErrorKind>>

Reads entries without checking last_add_confirmed locally if ledger not considered closed.

Notable errors

• ErrorKind::ReadExceedLastAddConfirmed if ledger closed and given entry id exceed last add confirmed.
• ErrorKind::EntryNotExisted if given entry does not exists.

pub fn closed(&self) -> bool

Returns whether ledger has been closed or not.

Trait Implementations

impl Clone for LedgerReader

fn clone(&self) -> LedgerReader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerReader

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

Formats the value using the given formatter.