Struct AppendApi

pub struct AppendApi<Vm: ApiVm> {
    pub sem_id: SemId,
    pub raw_sem_id: SemId,
    pub published: bool,
    pub adaptor: Vm::Adaptor,
}

API for append-only state.

API covers two main functions: taking structured data from the user input and building a valid state included into a new contract operation - and taking contract state and converting it into a user-friendly form, as a structured data (which may be lately used by readers performing aggregation of state into a collection-type objects).

Fields

sem_id: SemId

Semantic type id for verifiable part of the state.

raw_sem_id: SemId

Semantic type id for non-verifiable part of the state.

published: bool

adaptor: Vm::Adaptor

Procedures which convert a state made of finite field elements StateData into a structured type [StructData] and vice verse.

Implementations

impl<Vm: ApiVm> AppendApi<Vm>

pub fn convert(&self, data: &StateData, sys: &TypeSystem) -> Option<StateAtom>

pub fn build( &self, value: StrictVal, raw: Option<StrictVal>, sys: &TypeSystem, ) -> StateData

Build an immutable memory cell out of structured state.

Since append-only state includes both field elements (verifiable part of the state) and optional structured data (non-verifiable, non-compressible part of the state) it takes two inputs of a structured state data, leaving the raw part unchanged.

Trait Implementations

impl<Vm: Clone + ApiVm> Clone for AppendApi<Vm>

where Vm::Adaptor: Clone,

fn clone(&self) -> AppendApi<Vm>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Vm: Debug + ApiVm> Debug for AppendApi<Vm>

where Vm::Adaptor: Debug,

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

Formats the value using the given formatter.

impl<'de, Vm: ApiVm> Deserialize<'de> for AppendApi<Vm>

where Vm::Adaptor: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Vm: Hash + ApiVm> Hash for AppendApi<Vm>

where Vm::Adaptor: Hash,

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<Vm: Ord + ApiVm> Ord for AppendApi<Vm>

where Vm::Adaptor: Ord,

fn cmp(&self, other: &AppendApi<Vm>) -> 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<Vm: PartialEq + ApiVm> PartialEq for AppendApi<Vm>

where Vm::Adaptor: PartialEq,

fn eq(&self, other: &AppendApi<Vm>) -> 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<Vm: PartialOrd + ApiVm> PartialOrd for AppendApi<Vm>

where Vm::Adaptor: PartialOrd,

fn partial_cmp(&self, other: &AppendApi<Vm>) -> 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<Vm: ApiVm> Serialize for AppendApi<Vm>

where Vm::Adaptor: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Vm: ApiVm> StrictDecode for AppendApi<Vm>

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

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

impl<Vm: ApiVm> StrictDumb for AppendApi<Vm>

fn strict_dumb() -> Self

impl<Vm: ApiVm> StrictEncode for AppendApi<Vm>

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

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

impl<Vm: ApiVm> StrictStruct for AppendApi<Vm>

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

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl<Vm: ApiVm> StrictType for AppendApi<Vm>

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl<Vm: Eq + ApiVm> Eq for AppendApi<Vm>

where Vm::Adaptor: Eq,

impl<Vm: ApiVm> StrictProduct for AppendApi<Vm>

impl<Vm: ApiVm> StructuralPartialEq for AppendApi<Vm>