Struct Semantics

pub struct Semantics {
    pub version: u16,
    pub default: Api,
    pub custom: SmallOrdMap<TypeName, Api>,
    pub codex_libs: SmallOrdSet<Lib>,
    pub api_libs: SmallOrdSet<Lib>,
    pub types: TypeSystem,
}

A helper structure to store the contract semantics, made of a set of APIs, corresponding type system, and libs, used by the codex.

A contract may have multiple APIs defined; this structure summarizes information about them. The structure also holds a set of AluVM libraries for the codex and type system used by the APIs.

Fields

version: u16

Backward-compatible version number for the issuer.

This version number is used to decide which contract APIs to apply if multiple contract APIs are available.

default: Api

The default API.

custom: SmallOrdMap<TypeName, Api>

The custom named APIs.

The mechanism of the custom APIs allows a contract to have multiple implementations of the same interface.

For instance, a contract may provide multiple tokens using different token names.

codex_libs: SmallOrdSet<Lib>

A set of zk-AluVM libraries called from the contract codex.

api_libs: SmallOrdSet<Lib>

A set of AluVM libraries called from the APIs.

types: TypeSystem

The type system used by the contract APIs.

Implementations

impl Semantics

pub fn apis_checksum(&self) -> ApisChecksum

pub fn apis(&self) -> impl Iterator<Item = &Api>

Iterates over all APIs, including default and named ones.

pub fn check(&self, codex: &Codex) -> Result<(), SemanticError>

Check whether this semantics object matches codex and the provided set of libraries for it.

Trait Implementations

impl Clone for Semantics

fn clone(&self) -> Semantics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitEncode for Semantics

type CommitmentId = ApisChecksum

Type of the resulting commitment.

fn commit_encode(&self, e: &mut CommitEngine)

Encodes the data for the commitment by writing them directly into a std::io::Write writer instance

impl Debug for Semantics

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Semantics

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Semantics

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Semantics

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Semantics

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Semantics

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Semantics

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for Semantics

fn strict_dumb() -> Self

impl StrictEncode for Semantics

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictStruct for Semantics

const ALL_FIELDS: &'static [&'static str]

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Semantics

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl Eq for Semantics

impl StrictProduct for Semantics