Struct Reference 

#[non_exhaustive]
pub struct Reference {
    pub ns: String,
    pub fn_name: String,
    pub args: Args,
    pub fn_hash: Option<String>,
    pub asof: Option<String>,
}

A cell reference (4.3) with the optional pin of spec-0.4.2: fn_hash, the function the reference is pinned to, whatever its name is bound to (5.1, 5.8). Unpinned, it is the CellRef of spec-0.4.1 (From<CellRef>, Reference::to_cell_ref).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ns: String

The namespace.

fn_name: String

The function name within the namespace.

args: Args

The arguments, typed by the function’s signature.

fn_hash: Option<String>

The pin: the function hash the reference is pinned to, or None.

asof: Option<String>

The transaction time asked for; None means now.

Implementations

impl Reference

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

Parses a reference from JSON text: strict JSON, structure (fn_hash a string, E_SCHEMA), canonical form in JCS order (args, asof, fn, fn_hash as 64 lowercase hex digits (E_CANON_HEX), ns), then the 512-character function name.

pub fn new( ns: impl Into<String>, fn_name: impl Into<String>, args: Args, ) -> Reference

A reference to ns/fn_name with these arguments, unpinned and as of now; set fn_hash and asof to pin it or ask as of a time. Not checked: crate::format_reference writes what it is given.

pub fn to_value(&self) -> Value

The JSON form.

pub fn canonical(&self) -> Vec<u8>

The canonical bytes (6.2). A pinned reference without asof has the canonical bytes, and so the id, of the cell it denotes.

pub fn cell(&self) -> Option<Cell>

The cell a pinned reference denotes; None when it is not pinned (resolve its name with Reference::resolve).

pub fn resolve(&self, fn_hash: &str) -> Result<Cell>

The cell this reference denotes once its name has resolved to fn_hash. A pinned reference denotes its pin’s cell only: another hash is E_FN_HASH_MISMATCH.

pub fn to_cell_ref(&self) -> Option<CellRef>

The spec-0.4.1 form, when the reference is not pinned.

Trait Implementations

impl Clone for Reference

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 Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl From<CellRef> for Reference

fn from(r: CellRef) -> Reference

Converts to this type from the input type.

impl Hash for Reference

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reference