Struct snapshot::SnapshotReader

pub struct SnapshotReader {
    pub(crate) dir: PathBuf,
    pub(crate) key: Option<CryptKey>,
}

Reads snapshots created by SnapshotWriter.

Fields

dir: PathBuf

key: Option<CryptKey>

If encryption is used, the plaintext key will be stored here.

Implementations

impl SnapshotReader

pub fn new(root: &Path, require_encrypted: bool) -> Result<Self>

Reads a snapshot at root. Set require_encrypted to require an encrypted snapshot.

pub fn raw_fragment(&self, name: &str) -> Result<Box<dyn Read>>

Gets access to a Read impl that represents a fragment.

pub fn read_fragment<T: DeserializeOwned>(&self, name: &str) -> Result<T>

Reads a fragment.

pub fn list_fragments(&self) -> Result<Vec<String>>

Reads the names of all fragments in this namespace.

pub fn namespace(&self, name: &str) -> Result<Self>

Open a namespace.

pub fn list_namespaces(&self) -> Result<Vec<String>>

Reads the names of all child namespaces

Trait Implementations

impl Clone for SnapshotReader

fn clone(&self) -> SnapshotReader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotReader

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnapshotReader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SnapshotReader

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

where __S: Serializer,

Serialize this value into the given Serde serializer.