Skip to main content

SnapshotManager

Struct SnapshotManager 

Source
pub struct SnapshotManager<'a, S: Store> { /* private fields */ }
Expand description

Convenience API for branch, tag, checkpoint, or custom snapshot roots.

Implementations§

Source§

impl<'a, S: Store> SnapshotManager<'a, S>

Source

pub fn new(prolly: &'a Prolly<S>, namespace: SnapshotNamespace) -> Self

Create a manager for namespace using an existing Prolly manager.

Source

pub fn namespace(&self) -> &SnapshotNamespace

Return the namespace used by this manager.

Source

pub fn root_name(&self, id: impl AsRef<[u8]>) -> Vec<u8>

Build a durable named-root key from a namespace-local id.

Source

pub fn load(&self, id: impl AsRef<[u8]>) -> Result<Option<Tree>, Error>
where S: ManifestStore,

Load one snapshot by namespace-local id.

Source

pub fn load_many<I, Id>(&self, ids: I) -> Result<SnapshotSelection, Error>
where S: ManifestStore, I: IntoIterator<Item = Id>, Id: AsRef<[u8]>,

Load several snapshots by namespace-local id.

Source

pub fn publish(&self, id: impl AsRef<[u8]>, tree: &Tree) -> Result<(), Error>
where S: ManifestStore,

Publish or replace a snapshot.

Source

pub fn publish_at_millis( &self, id: impl AsRef<[u8]>, tree: &Tree, timestamp_millis: u64, ) -> Result<(), Error>
where S: ManifestStore,

Publish or replace a snapshot with an explicit timestamp.

Source

pub fn delete(&self, id: impl AsRef<[u8]>) -> Result<(), Error>
where S: ManifestStore,

Delete a snapshot. Deleting a missing snapshot is not an error.

Source

pub fn compare_and_swap( &self, id: impl AsRef<[u8]>, expected: Option<&Tree>, replacement: Option<&Tree>, ) -> Result<NamedRootUpdate, Error>
where S: ManifestStore,

Atomically update a snapshot when the current tree matches expected.

Source

pub fn compare_and_swap_at_millis( &self, id: impl AsRef<[u8]>, expected: Option<&Tree>, replacement: Option<&Tree>, timestamp_millis: u64, ) -> Result<NamedRootUpdate, Error>
where S: ManifestStore,

Atomically update a snapshot with an explicit timestamp.

Source

pub fn list(&self) -> Result<Vec<SnapshotRoot>, Error>

List all snapshots in this namespace.

Auto Trait Implementations§

§

impl<'a, S> Freeze for SnapshotManager<'a, S>

§

impl<'a, S> RefUnwindSafe for SnapshotManager<'a, S>
where S: RefUnwindSafe,

§

impl<'a, S> Send for SnapshotManager<'a, S>

§

impl<'a, S> Sync for SnapshotManager<'a, S>

§

impl<'a, S> Unpin for SnapshotManager<'a, S>

§

impl<'a, S> UnsafeUnpin for SnapshotManager<'a, S>

§

impl<'a, S> UnwindSafe for SnapshotManager<'a, S>
where S: RefUnwindSafe,

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, 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> 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.