Struct Articles

pub struct Articles { /* private fields */ }

Articles contain the contract and all related codex and API information for interacting with it.

Invariance

The structure provides the following invariance guarantees:

• all the API codex matches the codex under which the contract was issued;
• all the API ids are unique;
• all custom APIs have unique names;
• the signature, if present, is a valid sig over the ArticlesId.

Implementations

impl Articles

pub fn with<E>( semantics: Semantics, issue: Issue, sig: Option<SigBlob>, sig_validator: impl FnOnce(StrictHash, &Identity, &SigBlob) -> Result<(), E>, ) -> Result<Self, SemanticError>

Construct articles from a signed contract semantic and the contract issue under that semantics.

pub fn articles_id(&self) -> ArticlesId

Compute an article id, which includes information about the contract id, API version and checksum.

pub fn contract_id(&self) -> ContractId

Compute a contract id.

pub fn codex_id(&self) -> CodexId

Compute a codex id.

pub fn genesis_opid(&self) -> Opid

Compute a genesis opid.

pub fn semantics(&self) -> &Semantics

Get a reference to the contract semantic.

pub fn default_api(&self) -> &Api

Get a reference to the default API.

pub fn custom_apis(&self) -> impl Iterator<Item = (&TypeName, &Api)>

Get an iterator over the custom APIs.

pub fn types(&self) -> &TypeSystem

Get a reference to the type system.

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

Iterates over all APIs, including the default and the named ones.

pub fn codex_libs(&self) -> impl Iterator<Item = &Lib>

Iterates over all codex libraries.

pub fn issue(&self) -> &Issue

Get a reference to the contract issue information.

pub fn codex(&self) -> &Codex

Get a reference to the contract codex.

pub fn genesis(&self) -> &Genesis

Get a reference to the contract genesis.

pub fn contract_meta(&self) -> &ContractMeta

Get a reference to the contract meta-information.

pub fn contract_name(&self) -> &ContractName

Get a reference to the contract name.

pub fn sig(&self) -> &Option<SigBlob>

Get a reference to a signature over the contract semantics.

pub fn is_signed(&self) -> bool

Detect whether the articles are signed.

pub fn upgrade_apis(&mut self, other: Self) -> Result<bool, SemanticError>

Upgrades contract APIs if a newer version is available.

Returns

Whether the upgrade has happened, i.e. other represents a valid later version of the APIs.

pub fn call_id(&self, method: impl Into<MethodName>) -> CallId

Get a CallId for a method from the default API.

Panics

If the method name is not known.

Trait Implementations

impl Clone for Articles

fn clone(&self) -> Articles

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Articles

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

Formats the value using the given formatter.

impl LibRepo for Articles

fn get_lib(&self, lib_id: LibId) -> Option<&Lib>

Get a specific library with the provided id.

impl PartialEq for Articles

fn eq(&self, other: &Articles) -> 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 StrictDumb for Articles

fn strict_dumb() -> Self

impl StrictEncode for Articles

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

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

impl StrictStruct for Articles

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

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for Articles

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl Eq for Articles

impl StrictProduct for Articles

impl StructuralPartialEq for Articles