Struct Invoice 

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

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>

yanked_signature: Option<Vec<Signature>>

bindle: BindleSpec

annotations: Option<AnnotationMap>

parcel: Option<Vec<Parcel>>

group: Option<Vec<Group>>

signature: Option<Vec<Signature>>

Implementations

impl Invoice

pub fn new(spec: BindleSpec) -> Self

Create a new Invoice with a bindle specification.

The returned bindle will have no parcels, annotations, signatures, or groups.

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].

pub fn has_group(&self, name: &str) -> bool

Check whether a group by this name is present.

pub fn group_members(&self, name: &str) -> Vec<Parcel>

Get all of the parcels on the given group.

pub fn sign( &mut self, signer_role: SignatureRole, keyfile: &SecretKeyEntry, ) -> Result<(), SignatureError>

Sign the parcels on the current package.

Note that this signature will be invalidated if any parcels are added after this signature.

In the current version of the spec, a signature is generated by combining the signer’s ID, the invoice version, and a list of parcels, and then performing a cryptographic signature on those fields. The result is then stored in a [[signature]] block on the invoice. Multiple signatures can be attached to any invoice.

Trait Implementations

impl<T> Borrow<Invoice> for SignedInvoice<T>

where T: Into<Invoice> + Borrow<Invoice>,

fn borrow(&self) -> &Invoice

Immutably borrows from an owned value.

impl<T> Borrow<Invoice> for VerifiedInvoice<T>

where T: Into<Invoice> + Borrow<Invoice>,

fn borrow(&self) -> &Invoice

Immutably borrows from an owned value.

impl<T> BorrowMut<Invoice> for VerifiedInvoice<T>

where T: Into<Invoice> + BorrowMut<Invoice>,

fn borrow_mut(&mut self) -> &mut Invoice

Mutably borrows from an owned value.

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Into<Invoice>> Into<Invoice> for VerifiedInvoice<T>

fn into(self) -> Invoice

Converts this type into the (usually inferred) input type.

impl Serialize for Invoice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.