Skip to main content

RootManifest

Struct RootManifest 

Source
pub struct RootManifest {
    pub root: Option<Cid>,
    pub config: Config,
    pub created_at_millis: Option<u64>,
    pub updated_at_millis: Option<u64>,
}
Expand description

Durable named-root payload.

A root manifest stores the complete tree handle needed to reopen a named snapshot. The root CID alone is not enough because chunking and encoding config determine how the tree should be interpreted.

Fields§

§root: Option<Cid>

Root node CID, or None for the empty tree.

§config: Config

Tree configuration associated with this root.

§created_at_millis: Option<u64>

Optional Unix timestamp in milliseconds when this named root was created.

§updated_at_millis: Option<u64>

Optional Unix timestamp in milliseconds when this named root was updated.

Implementations§

Source§

impl RootManifest

Source

pub fn new(root: Option<Cid>, config: Config) -> Self

Create a new manifest from a root CID and config.

Source

pub fn with_timestamps_millis( self, created_at_millis: Option<u64>, updated_at_millis: Option<u64>, ) -> Self

Set optional creation and update timestamps in Unix milliseconds.

Source

pub fn with_created_at_millis(self, created_at_millis: u64) -> Self

Set the creation timestamp in Unix milliseconds.

Source

pub fn with_updated_at_millis(self, updated_at_millis: u64) -> Self

Set the update timestamp in Unix milliseconds.

Source

pub fn from_tree_with_timestamps_millis( tree: &Tree, created_at_millis: Option<u64>, updated_at_millis: Option<u64>, ) -> Self

Create a manifest from a tree and timestamp metadata.

Source

pub fn from_tree(tree: &Tree) -> Self

Create a manifest from an existing tree handle.

Source

pub fn into_tree(self) -> Tree

Convert this manifest into a tree handle.

Source

pub fn to_tree(&self) -> Tree

Convert this manifest into a cloned tree handle.

Source

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serialize this manifest to a versioned, deterministic binary payload.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Decode a manifest from bytes produced by RootManifest::to_bytes.

Trait Implementations§

Source§

impl Clone for RootManifest

Source§

fn clone(&self) -> RootManifest

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 RootManifest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RootManifest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&Tree> for RootManifest

Source§

fn from(tree: &Tree) -> Self

Converts to this type from the input type.
Source§

impl From<RootManifest> for Tree

Source§

fn from(manifest: RootManifest) -> Self

Converts to this type from the input type.
Source§

impl From<Tree> for RootManifest

Source§

fn from(tree: Tree) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for RootManifest

Source§

fn eq(&self, other: &RootManifest) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for RootManifest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RootManifest

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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