Skip to main content

Keyless

Struct Keyless 

Source
pub struct Keyless<E: Storage + Clock + Metrics, V: VariableValue, H: Hasher> { /* private fields */ }
Expand description

A keyless authenticated database for variable-length data.

Implementations§

Source§

impl<E: Storage + Clock + Metrics, V: VariableValue, H: Hasher> Keyless<E, V, H>

Source

pub async fn get(&self, loc: Location) -> Result<Option<V>, Error>

Get the value at location loc in the database.

§Errors

Returns Error::LocationOutOfBounds if loc >= self.bounds().await.end.

Source

pub const fn last_commit_loc(&self) -> Location

Returns the location of the last commit.

Source

pub async fn get_metadata(&self) -> Result<Option<V>, Error>

Get the metadata associated with the last commit.

Source

pub async fn init(context: E, cfg: Config<V::Cfg>) -> Result<Self, Error>

Returns a Keyless qmdb initialized from cfg. Any uncommitted operations will be discarded and the state of the db will be as of the last committed operation.

Source

pub fn root(&self) -> H::Digest

Return the root of the db.

Source

pub async fn proof( &self, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<H::Digest>, Vec<Operation<V>>), Error>

Generate and return:

  1. a proof of all operations applied to the db in the range starting at (and including) location start_loc, and ending at the first of either:
    • the last operation performed, or
    • the operation max_ops from the start.
  2. the operations corresponding to the leaves in this range.
Source

pub async fn historical_proof( &self, op_count: Location, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<H::Digest>, Vec<Operation<V>>), Error>

Analogous to proof, but with respect to the state of the MMR when it had op_count operations.

§Errors
Source

pub async fn prune(&mut self, loc: Location) -> Result<(), Error>

Prune historical operations prior to loc. This does not affect the db’s root.

§Errors
Source

pub async fn sync(&mut self) -> Result<(), Error>

Sync all database state to disk. While this isn’t necessary to ensure durability of committed operations, periodic invocation may reduce memory usage and the time required to recover the database on restart.

Source

pub async fn destroy(self) -> Result<(), Error>

Destroy the db, removing all data from disk.

Source

pub fn new_batch(&self) -> UnmerkleizedBatch<'_, E, V, H, Mmr<E, H::Digest>>

Create a new speculative batch of operations with this database as its parent.

Source

pub async fn apply_batch( &mut self, batch: Changeset<H::Digest, V>, ) -> Result<Range<Location>, Error>

Apply a changeset to the database.

A changeset is only valid if the database has not been modified since the batch that produced it was created. Multiple batches can be forked from the same parent for speculative execution, but only one may be applied. Applying a stale changeset returns Error::StaleChangeset.

Returns the range of locations written.

Trait Implementations§

Source§

impl<E: Storage + Clock + Metrics, V: VariableValue, H: Hasher> LogStore for Keyless<E, V, H>

Source§

type Value = V

Source§

async fn bounds(&self) -> Range<Location>

Return [start, end) where start and end - 1 are the Locations of the oldest and newest retained operations respectively.
Source§

async fn get_metadata(&self) -> Result<Option<Self::Value>, Error>

Get the metadata associated with the last commit.
Source§

fn size(&self) -> impl Future<Output = Location> + Send

Return the Location of the next operation appended to this db.
Source§

impl<E: Storage + Clock + Metrics, V: VariableValue, H: Hasher> MerkleizedStore for Keyless<E, V, H>

Source§

type Digest = <H as Hasher>::Digest

The digest type used for authentication.
Source§

type Operation = Operation<V>

The operation type stored in the log.
Source§

fn root(&self) -> Self::Digest

Returns the root digest of the authenticated store.
Source§

async fn historical_proof( &self, historical_size: Location, start_loc: Location, max_ops: NonZeroU64, ) -> Result<(Proof<Self::Digest>, Vec<Self::Operation>), Error>

Generate and return: Read more
Source§

fn proof( &self, start_loc: Location, max_ops: NonZeroU64, ) -> impl Future<Output = Result<(Proof<Self::Digest>, Vec<Self::Operation>), Error>> + Send

Generate and return: Read more

Auto Trait Implementations§

§

impl<E, V, H> !Freeze for Keyless<E, V, H>

§

impl<E, V, H> !RefUnwindSafe for Keyless<E, V, H>

§

impl<E, V, H> Send for Keyless<E, V, H>

§

impl<E, V, H> Sync for Keyless<E, V, H>

§

impl<E, V, H> Unpin for Keyless<E, V, H>
where H: Unpin, E: Unpin, <H as Hasher>::Digest: Unpin, <V as Read>::Cfg: Unpin, <E as Storage>::Blob: Unpin,

§

impl<E, V, H> UnsafeUnpin for Keyless<E, V, H>

§

impl<E, V, H> !UnwindSafe for Keyless<E, V, H>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,