Struct tvix_store::proto::PathInfo

pub struct PathInfo {
    pub node: Option<Node>,
    pub references: Vec<Bytes>,
    pub narinfo: Option<NarInfo>,
}

PathInfo shows information about a Nix Store Path. That’s a single element inside /nix/store.

Fields

node: Option<Node>

The path can be a directory, file or symlink.

references: Vec<Bytes>

List of references (output path hashes) This really is the raw bytes, after decoding nixbase32, and not a base32-encoded string.

narinfo: Option<NarInfo>

see below.

Implementations

impl PathInfo

pub fn validate(&self) -> Result<StorePath<String>, ValidatePathInfoError>

validate performs some checks on the PathInfo struct, Returning either a store_path::StorePath of the root node, or a ValidatePathInfoError.

pub fn to_narinfo<'a>( &'a self, store_path: StorePathRef<'a> ) -> Option<NarInfo<'_>>

With self and its store path name, this reconstructs a [nix_compat::narinfo::NarInfo<’_>]. It can be used to validate Signatures, or get back a (sparse) NarInfo struct to prepare writing it out.

It assumes self to be validated first, and will only return None if the narinfo field is unpopulated.

It does very little allocation (a Vec each for signatures and references), the rest points to data owned elsewhere.

Keep in mind this is not able to reconstruct all data present in the NarInfo<’_>, as some of it is not stored at all:

• the system, file_hash and file_size fields are set to None.
• the URL is set to an empty string.
• Compression is set to “none”

If you want to render it out to a string and be able to parse it back in, at least URL must be set again.

Trait Implementations

impl Clone for PathInfo

fn clone(&self) -> PathInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathInfo

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

Formats the value using the given formatter.

impl Default for PathInfo

fn default() -> Self

Returns the “default value” for a type.

impl From<&NarInfo<'_>> for PathInfo

fn from(value: &NarInfo<'_>) -> Self

Converts from a NarInfo (returned from the NARInfo parser) to a PathInfo struct with the node set to None.

impl Message for PathInfo

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PathInfo

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