Struct SnapshotFilePath 

#[non_exhaustive]
pub struct SnapshotFilePath(pub PathBuf);

A snapshot file. {data-dir}/replica/$replica_id/snapshots/$tx_offset.snapshot_dir/$tx_offset.snapshot_bsatn

Tuple Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

0: PathBuf

Implementations

impl SnapshotFilePath

pub fn display(&self) -> Display<'_>

pub fn metadata(&self) -> Result<Metadata>

impl SnapshotFilePath

pub fn read(&self) -> Result<Vec<u8>>

pub fn read_to_string(&self) -> Result<String>

pub fn write(&self, contents: impl AsRef<[u8]>) -> Result<()>

pub fn open_file(&self, options: &OpenOptions) -> Result<File>

Opens a file at this path with the given options, ensuring its parent directory exists.

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

Create the parent directory of this path if it doesn’t already exist.

Trait Implementations

impl AsRef<OsStr> for SnapshotFilePath

fn as_ref(&self) -> &OsStr

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Path> for SnapshotFilePath

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for SnapshotFilePath

fn clone(&self) -> SnapshotFilePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotFilePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnapshotFilePath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OsString> for SnapshotFilePath

fn from(s: OsString) -> Self

Converts to this type from the input type.

impl FromPathUnchecked for SnapshotFilePath

fn from_path_unchecked(path: impl Into<PathBuf>) -> Self

The responsibility is on the caller to verify that the path is valid for this directory structure node.

impl Serialize for SnapshotFilePath

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

where __S: Serializer,

Serialize this value into the given Serde serializer.