Skip to main content

Ledger

Struct Ledger 

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

An append-only ledger held in memory. Persistent storage is the caller’s responsibility: call Ledger::serialize to get a CAS-ready blob, Ledger::deserialize to restore.

Implementations§

Source§

impl Ledger

Source

pub fn new(secret: SessionSecret) -> Self

Open a fresh ledger with the given session secret.

Source

pub fn entries(&self) -> &[LedgerEntry]

Borrow the ledger entries in causal order.

Source

pub fn append( &mut self, timestamp: DateTime<Utc>, tool_id: impl Into<String>, args_hash: Digest256, idempotency_key: impl Into<String>, result_hash: Digest256, side_effect_class: SideEffectClass, ) -> Result<&LedgerEntry>

Append a new entry and chain its HMAC. The caller supplies everything except session_hmac, which we compute here.

Source

pub fn verify(&self) -> Result<()>

Verify the entire HMAC chain. Returns Ok(()) if every entry verifies in order; otherwise the first bad-entry index in Err.

Source

pub fn serialize(&self, blobs: &dyn BlobStore) -> Result<Digest256>

Serialize the ledger to a single JSONL blob and store via blobs. Note: the secret is NOT serialized — it must be re-supplied at deserialization time.

Source

pub fn deserialize( blobs: &dyn BlobStore, digest: &Digest256, secret: SessionSecret, ) -> Result<Self>

Restore a ledger from a previously-stored blob. The caller must supply the same secret that signed the chain; otherwise Self::verify will fail.

Trait Implementations§

Source§

impl Clone for Ledger

Source§

fn clone(&self) -> Ledger

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 Ledger

Source§

fn fmt(&self, f: &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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.