Struct hoard::hoard_item::CachedHoardItem

pub struct CachedHoardItem { /* private fields */ }

Wrapper around HoardItem that accesses the filesystem at creation time and caches file data.

Usage

This does nothing to ensure that files are not modified during its lifetime. For directly interacting with files on the filesystem, HoardItem may be better.

This struct is useful for prolonged processing of a given file.

Implementations

impl CachedHoardItem

pub async fn new( pile_name: PileName, hoard_prefix: HoardPath, system_prefix: SystemPath, relative_path: RelativePath ) -> Result<Self>

Create a new CachedHoardItem.

See HoardItem::new for more about usage.

Errors

Will return I/O errors if they occur while processing file data, with the exception of NotFound errors, which are translated into None values, as applicable.

pub async fn try_from_hoard_item(inner: HoardItem) -> Result<Self>

Attempt to create a cached version of the given HoardItem

Errors

Any I/O errors while reading the associated files, etc.

pub fn pile_name(&self) -> &PileName

Returns the name of the pile this item belongs to, if any.

pub fn relative_path(&self) -> &RelativePath

Returns the relative path for this item.

pub fn hoard_prefix(&self) -> &HoardPath

Returns the hoard-controlled path for this item’s pile.

pub fn system_prefix(&self) -> &SystemPath

Returns the system path for this item’s pile.

pub fn hoard_path(&self) -> &HoardPath

Returns the Hoard-controlled path for this item.

If HoardItem::relative_path() is None, this is the same as HoardItem::hoard_prefix().

pub fn system_path(&self) -> &SystemPath

Returns the system path for this item.

If HoardItem::relative_path() is None, this is the same as HoardItem::system_prefix().

pub fn is_file(&self) -> bool

Returns whether this item is a file.

This is true if:

• At least one of hoard_path or system_path exists
• All existing paths are a file

pub fn is_dir(&self) -> bool

Returns whether this item is a directory.

This is true if:

• At least one of hoard_path or system_path exists
• All existing paths are directories

pub fn is_text(&self) -> bool

Returns whether this file contains text.

This is true if at least one file (system/hoard) exists and all files that exist contain text.

pub fn is_binary(&self) -> bool

Returns whether this file does not contains text.

This is true if at least one file (system/hoard) exists and is not text.

pub fn diff(&self) -> Option<&Diff>

Returns the precomputed diff between the hoard and system files of this CachedHoardItem.

pub fn hoard_checksum(&self, typ: ChecksumType) -> Option<Checksum>

Returns the requested ChecksumType for the Hoard version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if hoard_path is a directory.

If always calling this function with a constant or programmer-determined value, consider using CachedHoardItem::hoard_md5 or CachedHoardItem::hoard_sha256 instead.

pub fn hoard_md5(&self) -> Option<Checksum>

Returns the MD5 checksum for the Hoard version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if hoard_path is a directory.

pub fn hoard_sha256(&self) -> Option<Checksum>

Returns the SHA256 checksum for the Hoard version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if hoard_path is a directory.

pub fn system_checksum(&self, typ: ChecksumType) -> Option<Checksum>

Returns the requested ChecksumType for the system version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if system_path is a directory.

If always calling this function with a constant or programmer-determined value, consider using CachedHoardItem::system_md5 or CachedHoardItem::system_sha256 instead.

pub fn system_md5(&self) -> Option<Checksum>

Returns the MD5 checksum for the system version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if system_path is a directory.

pub fn system_sha256(&self) -> Option<Checksum>

Returns the SHA256 checksum for the system version of the file.

Errors

Returns Ok(None) if the file does not exist, and errors for all other error cases for std::fs::read, including if system_path is a directory.

Trait Implementations

impl Clone for CachedHoardItem

fn clone(&self) -> CachedHoardItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CachedHoardItem

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

Formats the value using the given formatter.

impl From<CachedHoardItem> for HoardItem

fn from(cached: CachedHoardItem) -> Self

Converts to this type from the input type.

impl Hash for CachedHoardItem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CachedHoardItem

fn cmp(&self, other: &CachedHoardItem) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CachedHoardItem

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CachedHoardItem

fn partial_cmp(&self, other: &CachedHoardItem) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CachedHoardItem

impl StructuralEq for CachedHoardItem

impl StructuralPartialEq for CachedHoardItem