Struct Package 

pub struct Package {
    pub manifest: PackagesManifest,
    pub tgz: Bytes,
}

An in memory representation of a buffrs package

Fields

manifest: PackagesManifest

Manifest of the package

tgz: Bytes

The tar.gz archive containing the protocol buffers

Implementations

impl Package

pub fn create( manifest: PackagesManifest, files: BTreeMap<PathBuf, Entry>, preserve_mtime: bool, ) -> Result<Self>

Create new Package from [Manifest] and list of files.

This intentionally uses a BTreeMap to ensure that the list of files is sorted lexicographically. This ensures a reproducible output.

pub async fn unpack(&self, path: &Path) -> Result<()>

Unpack a package to a specific path.

pub fn name(&self) -> &PackageName

The name of this package

pub fn version(&self) -> &Version

The version of this package

pub fn digest(&self, algorithm: DigestAlgorithm) -> Digest

Digest calculates the digest based on the downloaded package bytes

pub fn lock( &self, registry: RegistryUri, repository: String, dependants: usize, ) -> LockedPackage

Lock this package

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Eq for Package

impl From<&Package> for Entry

fn from(value: &Package) -> Self

Converts to this type from the input type.

impl From<Package> for Entry

fn from(value: Package) -> Self

Converts to this type from the input type.

impl PartialEq for Package

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

impl TryFrom<Bytes> for Package

type Error = Report

The type returned in the event of a conversion error.

fn try_from(tgz: Bytes) -> Result<Self, Self::Error>

Performs the conversion.