Skip to main content

Receipt

Struct Receipt 

Source
pub struct Receipt { /* private fields */ }
Expand description

A receipt (8.1) that has passed verification steps 1-4: strict JSON, structure, canonical form and consistency. Its signature has not been checked; use crate::verify.

The members are private and read through getters, so the cached payload and hash always describe them. A Receipt comes only from from_json (or from_value for JSON already parsed) and, with feature sign, from ReceiptBuilder::sign.

Implementations§

Source§

impl Receipt

Source

pub fn from_json(bytes: &[u8]) -> Result<Receipt>

Parses a receipt and runs verification steps 1-4 (10.1).

Source

pub fn from_value(v: &Value) -> Result<Receipt>

Runs verification steps 2-4 on a parsed JSON value.

Source

pub fn payload(&self) -> &[u8] ⓘ

The signed payload: canonical bytes of the receipt without sig (8.3).

Source

pub fn hash(&self) -> &str

The receipt hash: SHA-256 of the payload, lowercase hex (8.3).

Source

pub fn asof(&self) -> &str

The transaction time answered as of.

Source

pub fn cell(&self) -> &Cell

The cell answered (no slices).

Source

pub fn computed_by(&self) -> &str

<host>#<key id> of the signing key.

Source

pub fn inputs(&self) -> &[String]

The inputs entries, ascending: receipt hashes and, since spec-0.4.0, slice entries slice:<slice id>:<members hash> (which sort after every receipt hash).

Source

pub fn issued(&self) -> &str

When the receipt was signed.

Source

pub fn licence(&self) -> &str

An SPDX identifier or an https URL.

Source

pub fn publisher(&self) -> &str

The namespace that owns the function; equals cell.ns.

Source

pub fn sig(&self) -> &str

The Ed25519 signature, 128 lowercase hex digits.

Source

pub fn summary(&self) -> &str

One human sentence.

Source

pub fn tx(&self) -> &str

When the value was recorded.

Source

pub fn value(&self) -> &Scalar

The value, typed.

Source

pub fn valid(&self) -> &Args

The valid-time arguments, echoed from cell.args.

Source

pub fn ty(&self) -> Type

The value’s type (the type member).

Source

pub fn signer_host(&self) -> &str

The host of computed_by.

Source

pub fn key_id(&self) -> &str

The key id of computed_by.

Trait Implementations§

Source§

impl Clone for Receipt

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Receipt

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Receipt

Source§

impl Hash for Receipt

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Receipt

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Receipt

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.