Struct StorePath

pub struct StorePath<S> {
    digest: [u8; 20],
    name: S,
}

Represents a path in the Nix store (a direct child of STORE_DIR).

It consists of a digest (20 bytes), and a name, which is a string. The name may only contain ASCII alphanumeric, or one of the following characters: -, _, ., +, ?, =. The name is usually used to describe the pname and version of a package. Derivation paths can also be represented as store paths, their names just end with the .drv prefix.

A StorePath does not encode any additional subpath “inside” the store path.

Fields

digest: [u8; 20]

name: S

Implementations

impl<S> StorePath<S>

where S: AsRef<str>,

pub fn digest(&self) -> &[u8; 20]

pub fn name(&self) -> &S

pub fn as_ref(&self) -> StorePathRef<'_>

pub fn to_owned(&self) -> StorePath<String>

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

where S: From<&'a str>,

Construct a StorePath by passing the $digest-$name string that comes after STORE_DIR_WITH_SLASH.

pub fn from_name_and_digest<'a>( name: &'a str, digest: &[u8], ) -> Result<Self, Error>

where S: From<&'a str>,

Construct a StorePathRef from a name and digest. The name is validated, and the digest checked for size.

pub fn from_name_and_digest_fixed<'a>( name: &'a str, digest: [u8; 20], ) -> Result<Self, Error>

where S: From<&'a str>,

Construct a StorePathRef from a name and digest of correct length. The name is validated.

pub fn from_absolute_path<'a>(s: &'a [u8]) -> Result<Self, Error>

where S: From<&'a str>,

Construct a StorePathRef from an absolute store path string. This is equivalent to calling StorePathRef::from_bytes, but stripping the STORE_DIR_WITH_SLASH prefix before.

pub fn from_absolute_path_full<'a, P>( path: &'a P, ) -> Result<(Self, &'a Path), Error>

where S: From<&'a str>, P: AsRef<Path> + ?Sized,

Decompose a string into a StorePath and a Path containing the rest of the path, or an error.

pub fn to_absolute_path(&self) -> String

Returns an absolute store path string. That is just the string representation, prefixed with the store prefix (STORE_DIR_WITH_SLASH),

Trait Implementations

impl<S> AtermWriteable for StorePath<S>

where S: AsRef<str>,

fn aterm_write(&self, writer: &mut impl Write) -> Result<()>

impl<S: Clone> Clone for StorePath<S>

fn clone(&self) -> StorePath<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for StorePath<S>

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

Formats the value using the given formatter.

impl<'a, 'de: 'a, S> Deserialize<'de> for StorePath<S>

where S: AsRef<str> + From<&'a str>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> Display for StorePath<S>

where S: AsRef<str>,

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

The string representation of a store path starts with a digest (20 bytes), crate::nixbase32-encoded, followed by a -, and ends with the name.

impl FromStr for StorePath<String>

fn from_str(s: &str) -> Result<Self, Self::Err>

Construct a StorePath by passing the $digest-$name string that comes after STORE_DIR_WITH_SLASH.

type Err = Error

The associated error which can be returned from parsing.

impl<S> Hash for StorePath<S>

where S: AsRef<str>,

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 NixDeserialize for StorePath<String>

async fn try_deserialize<R>(reader: &mut R) -> Result<Option<Self>, R::Error>

where R: ?Sized + NixRead + Send,

Read a value from the reader. This returns an Option to support gracefull shutdown.

fn deserialize<R>( reader: &mut R, ) -> impl Future<Output = Result<Self, R::Error>> + Send + '_

where R: ?Sized + NixRead + Send,

impl<S> NixSerialize for StorePath<S>

where S: AsRef<str>,

fn serialize<W>( &self, writer: &mut W, ) -> impl Future<Output = Result<(), W::Error>> + Send

where W: NixWrite,

Write a value to the writer.

impl<S> Ord for StorePath<S>

where S: AsRef<str>,

StorePaths are sorted by their reverse digest to match the sorting order of the nixbase32-encoded string.

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<S> PartialEq for StorePath<S>

where S: AsRef<str>,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<S> PartialOrd for StorePath<S>

where S: AsRef<str>,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<S> Serialize for StorePath<S>

where S: AsRef<str>,

fn serialize<SR>(&self, serializer: SR) -> Result<SR::Ok, SR::Error>

where SR: Serializer,

Serialize this value into the given Serde serializer.

impl<S> Eq for StorePath<S>

where S: AsRef<str>,