Struct libimagstore::storeid::StoreId

pub struct StoreId { /* fields omitted */ }

The Index into the Store

A StoreId object is a unique identifier for one entry in the store which might be present or not.

Methods

impl StoreId

pub fn new(base: Option<PathBuf>, id: PathBuf) -> Result<StoreId>

pub fn from_full_path<D>(store_part: &PathBuf, full_path: D) -> Result<StoreId> where
    D: Deref<Target = Path>, 

Try to create a StoreId object from a filesystem-absolute path.

Automatically creates a StoreId object which has a base set to store_part if stripping the store_part from the full_path succeeded.

pub fn new_baseless(id: PathBuf) -> Result<StoreId>

pub fn without_base(self) -> StoreId

pub fn with_base(self, base: PathBuf) -> Self

pub fn into_pathbuf(self) -> Result<PathBuf>

Transform the StoreId object into a PathBuf, error if the base of the StoreId is not specified.

pub fn exists(&self) -> Result<bool>

Check whether the StoreId exists (as in whether the file exists)

Warning

Should be considered deprecated

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

pub fn local_display_string(&self) -> String

Helper function for creating a displayable String from StoreId

This is safe because the

    impl<T: fmt::Display + ?Sized> ToString for T

does only fail if Display::display() failed. The implementation of ::std::path::Display and the implementation ::std::fmt::Display for ::std::path::Display do not return errors though.

pub fn components(&self) -> Components

Returns the components of the id part of the StoreId object.

Can be used to check whether a StoreId points to an entry in a specific collection of StoreIds.

pub fn local(&self) -> &PathBuf

Get the local part of a StoreId object, as in "the part from the store root to the entry".

pub fn is_in_collection<S: AsRef<str>, V: AsRef<[S]>>(&self, colls: &V) -> bool

Check whether a StoreId points to an entry in a specific collection.

A "collection" here is simply a directory. So foo/bar/baz is an entry which is in collection ["foo", "bar", "baz"], but also in ["foo", "bar"] and ["foo"].

Warning

The collection specification has to start with the module name. Otherwise this function may return false negatives.

pub fn local_push<P: AsRef<Path>>(&mut self, path: P)

Trait Implementations

impl IntoStoreId for StoreId

fn into_storeid(self) -> Result<StoreId>

impl PartialOrd<StoreId> for StoreId

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

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

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

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

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

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

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

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

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

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

impl PartialEq<StoreId> for StoreId

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

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

#[must_use]

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

This method tests for !=.

impl Clone for StoreId

fn clone(&self) -> StoreId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for StoreId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for StoreId

impl Display for StoreId

fn fmt(&self, fmt: &mut Formatter) -> RResult<(), FmtError>

Formats the value using the given formatter.

impl Debug for StoreId

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

Formats the value using the given formatter.

impl Hash for StoreId

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, 

Feeds a slice of this type into the given [Hasher].