Struct ReceiptBuilder 

pub struct ReceiptBuilder { /* private fields */ }

The members of a receipt before it is signed; sign is the only way to turn it into a Receipt.

Every member of 8.1 has a setter except proto (always datumesh/1), type (the value’s type), sig (made by sign) and computed_by: that one is derived, as <signer host>#<key id of the signing key>, so a receipt naming another key than the one that signed it cannot be built. inputs defaults to empty (a stored cell); every other member must be set.

Nothing is repaired: sign checks the members exactly as Receipt::from_json checks a parsed receipt (steps 2-4 of 10.1) and returns the error it would report.

Implementations

impl ReceiptBuilder

pub fn new() -> ReceiptBuilder

A builder with no members set.

pub fn cell(self, cell: Cell) -> Self

The cell answered (no slices).

pub fn value(self, value: Scalar) -> Self

The value; also sets type.

pub fn valid(self, valid: Args) -> Self

The valid-time arguments, echoed from the cell’s arguments ({} if none).

pub fn asof(self, asof: impl Into<String>) -> Self

The transaction time answered as of.

pub fn tx(self, tx: impl Into<String>) -> Self

When the value was recorded.

pub fn issued(self, issued: impl Into<String>) -> Self

When the receipt is signed.

pub fn publisher(self, publisher: impl Into<String>) -> Self

The namespace that owns the function; must equal the cell’s ns.

pub fn signer_host(self, host: impl Into<String>) -> Self

The host publishing the signing key: computed_by is <host>#<key id>.

pub fn inputs<I, S>(self, inputs: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Receipt hashes of the inputs; must be strictly ascending.

pub fn licence(self, licence: impl Into<String>) -> Self

An SPDX identifier or an https URL.

pub fn summary(self, summary: impl Into<String>) -> Self

One human sentence saying what the value is.

pub fn sign(&self, key: &SigningKey) -> Result<Receipt>

Checks the members as Receipt::from_json does, then signs the payload (8.3) with key. The receipt’s computed_by is <signer host>#<key.key_id()>.

Errors: E_SCHEMA for a member not set (path $), otherwise the code and path from_json reports for the same members.

Trait Implementations

impl Clone for ReceiptBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiptBuilder

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

Formats the value using the given formatter.

impl Default for ReceiptBuilder

fn default() -> Self

Returns the “default value” for a type.