Struct Distinfo 

pub struct Distinfo { /* private fields */ }

Distinfo contains the contents of a distinfo file.

The primary interface for populating a Distinfo from an existing distinfo file is using the from_bytes function. There is no error handling. Any input that is unrecognised or not in the correct format is simply ignored.

To create a new distinfo file, use new and set the fields manually.

Implementations

impl Distinfo

pub fn new() -> Distinfo

Return a new empty Distinfo.

pub fn rcsid(&self) -> Option<&OsString>

Return an Option containing either a valid $NetBSD: ... RCS Id line, or None if one was not found.

pub fn set_rcsid(&mut self, rcsid: &OsString)

Set the rcsid value.

pub fn get_distfile<P: AsRef<Path>>(&self, path: P) -> Option<&Entry>

Return a matching distfile Entry if found, otherwise None.

pub fn get_patchfile<P: AsRef<Path>>(&self, path: P) -> Option<&Entry>

Return a matching patchfile Entry if found, otherwise None.

pub fn distfiles(&self) -> Vec<&Entry>

Return a Vec of references to distfile entries, if any.

pub fn patchfiles(&self) -> Vec<&Entry>

Return a Vec of references to patchfile entries, if any.

pub fn calculate_size<P: AsRef<Path>>(path: P) -> Result<u64, DistinfoError>

Calculate size of a PathBuf.

pub fn calculate_checksum<P: AsRef<Path>>( path: P, digest: Digest, ) -> Result<String, DistinfoError>

Calculate Digest hash for a Path. The hash will differ depending on the EntryType of the supplied path.

pub fn insert(&mut self, entry: Entry) -> bool

Insert a populated Entry into the Distinfo.

pub fn find_entry<P: AsRef<Path>>( &self, path: P, ) -> Result<&Entry, DistinfoError>

Find an Entry in the current Distinfo given a Path. Distinfo distfile entries may include a directory component (DIST_SUBDIR) so applications can’t simply look up by filename.

This function iterates over the Path in reverse, adding any leading components until an entry is found, or returns DistinfoError::NotFound.

pub fn verify_size<P: AsRef<Path>>(&self, path: P) -> Result<u64, DistinfoError>

Pass the full path to a file to check as a PathBuf and verify that it matches the size stored in the Distinfo.

Returns the size if Ok, otherwise return a DistinfoError.

pub fn verify_checksum<P: AsRef<Path>>( &self, path: P, digest: Digest, ) -> Result<Digest, DistinfoError>

Pass the full path to a file to check as a PathBuf and verify that it matches a specific Digest checksum stored in the Distinfo.

Return the Digest if Ok, otherwise return a DistinfoError.

To verify all stored checksums use use verify_checksums.

pub fn verify_checksums<P: AsRef<Path>>( &self, path: P, ) -> Vec<Result<Digest, DistinfoError>>

Pass the full path to a file to check as a PathBuf and verify that it matches all of the checksums stored in the Distinfo. Returns a Vec of Results containing the Digest if Ok, otherwise return a DistinfoError.

pub fn from_bytes(bytes: &[u8]) -> Distinfo

Read a Vec of u8 bytes and parse for Distinfo entries. If nothing is found then an empty Distinfo is returned.

pub fn as_bytes(&self) -> Vec<u8>

Convert Distinfo into a byte representation suitable for writing to a distinfo file. The contents will be ordered as expected.

Trait Implementations

impl Clone for Distinfo

fn clone(&self) -> Distinfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Distinfo

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

Formats the value using the given formatter.

impl Default for Distinfo

fn default() -> Distinfo

Returns the “default value” for a type.

impl PartialEq for Distinfo

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

impl StructuralPartialEq for Distinfo