Struct FunctionDescriptor 

#[non_exhaustive]
pub struct FunctionDescriptor {
    pub lang: String,
    pub body: String,
    pub inputs: Vec<String>,
    pub signature: Signature,
    pub order: Option<Vec<String>>,
    pub extents: BTreeMap<String, Extent>,
}

A function descriptor (7) with the optional members of spec-0.4.0: signature.order and argument extent. Absent, it is the Descriptor of spec-0.3.0, byte for byte and hash for hash (From<Descriptor>, to_descriptor).

The fields are public to read; a value changed by hand is not checked again until it is parsed: FunctionDescriptor::from_value(&d.to_value()) checks it.

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.

lang: String

code.lang, e.g. stored or formula.

body: String

code.body, opaque to this crate.

inputs: Vec<String>

Fully qualified names of the functions this one may read, ascending.

signature: Signature

The signature’s arguments and return; its order and the arguments’ extents are order and extents.

order: Option<Vec<String>>

signature.order: every argument name exactly once, the order positional arguments bind in (15.5); None when absent.

extents: BTreeMap<String, Extent>

The arguments’ extent members, by argument name; empty when none has one.

Implementations

impl FunctionDescriptor

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

Parses a descriptor from JSON text: strict JSON, structure, canonical form (7), with order and extent and their checks (E_SCHEMA for their shapes, E_CANON_SET, E_CANON_TYPE, E_CANON_NUMBER, E_CANON_LIMIT and the lexical codes otherwise).

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

Checks a parsed JSON value as a descriptor.

pub fn to_value(&self) -> Value

The JSON form.

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

The canonical bytes (6.2).

pub fn hash(&self) -> String

The function hash: SHA-256 of the canonical bytes, lowercase hex.

pub fn to_descriptor(&self) -> Option<Descriptor>

The spec-0.3.0 form, when there is no order and no extent.

pub fn resolve_unit(&self, cell: &Cell) -> Result<Option<String>>

The unit of cell’s value (7.1, units.md 3), as resolve_with does for a Descriptor; None when the function does not return a number.

Trait Implementations

impl Clone for FunctionDescriptor

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 FunctionDescriptor

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

Formats the value using the given formatter.

impl Eq for FunctionDescriptor

impl From<Descriptor> for FunctionDescriptor

fn from(d: Descriptor) -> FunctionDescriptor

Converts to this type from the input type.

impl Hash for FunctionDescriptor

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 FunctionDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FunctionDescriptor