Struct StoreState

pub struct StoreState { /* private fields */ }

The state of the Nix store at a given point in time

Implementations

impl StoreState

pub fn new(config: NixConfiguration) -> Self

Create a new, empty, StoreState with the specified Nix configuration

pub fn add_path(&mut self, path: impl AsRef<Path>) -> Result<(), StoreError>

Add a path to the StoreState

Errors

Will propagate an error if the prefix is impossible to strip due to misconfiguration

pub fn paths(&self) -> impl Iterator<Item = PathBuf> + '_

Iterator over the paths in this StoreState

pub fn diff(&self, other: &StoreState) -> Result<Self, StoreError>

Return all paths that are different between this StoreState and another StoreState

This returns elements that are in other, but not in self

Errors

Will return an error if two stores with incompatible configuration are compared.

pub fn path_count(&self) -> usize

Returns the number of unique paths in the store

pub fn from_store_excluding( configuration: &NixConfiguration, excludes: &[Regex], ) -> Result<Self, StoreError>

Create a StoreState from the current status of the Nix store pointed to by the given NixConfiguration including installables as well as other paths matching the supplied regexes

Errors

Will propagate any IO errors that occur trying to enumerate the Nix store

pub fn from_store(configuration: &NixConfiguration) -> Result<Self, StoreError>

Create a StoreState from the current status of the Nix store pointed to by the given NixConfiguration

This is a wrapper around from_store_excluding with the default include filters implied.

The default filters will include:

• Any installable (non-disableable)
• Any nix-shell derivations

Errors

Will propagate any IO errors that occur trying to enumerate the Nix store

pub async fn filter_against_cache( self, cache_uri: &str, ) -> Result<Self, StoreError>

Filter this Store state against the given nix binary cache, removing any paths that are present in the cache. The provided cache uri is expected not to have a trailing slash

Errors

Will propagate any network or nix store interaction errors that occur

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for StoreState

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for StoreState

fn clone(&self) -> StoreState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreState

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for StoreState

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for StoreState

fn default() -> StoreState

Returns the “default value” for a type.

impl Encode for StoreState

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl PartialEq for StoreState

fn eq(&self, other: &StoreState) -> 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 Eq for StoreState

impl StructuralPartialEq for StoreState