Struct bindle::Invoice

pub struct Invoice {
    pub bindle_version: String,
    pub yanked: Option<bool>,
    pub bindle: BindleSpec,
    pub annotations: Option<BTreeMap<String, String>>,
    pub parcel: Option<Vec<Parcel>>,
    pub group: Option<Vec<Group>>,
}

The main structure for a Bindle invoice.

The invoice describes a specific version of a bindle. For example, the bindle foo/bar/1.0.0 would be represented as an Invoice with the BindleSpec name set to foo/bar and version set to 1.0.0.

Most fields on this struct are singular to best represent the specification. There, fields like group and parcel are singular due to the conventions of TOML.

Fields

bindle_version: String

yanked: Option<bool>

bindle: BindleSpec

annotations: Option<BTreeMap<String, String>>

parcel: Option<Vec<Parcel>>

group: Option<Vec<Group>>

Implementations

impl Invoice

pub fn name(&self) -> String

produce a slash-delimited "invoice name"

For example, an invoice with the bindle name "hello" and the bindle version "1.2.3" will produce "hello/1.2.3"

pub fn canonical_name(&self) -> String

Creates a standard name for an invoice

This is designed to create a repeatable opaque name for the invoice We don't typically want to have a bindle ID using its name and version number. This would impose both naming constraints on the bindle and security issues on the storage layout. So this function hashes the name/version data (which together MUST be unique in the system) and uses the resulting hash as the canonical name. The hash is guaranteed to be in the character set [a-zA-Z0-9].

Trait Implementations

impl Clone for Invoice

pub fn clone(&self) -> Invoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invoice

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Invoice

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.