Struct State

#[repr(C)]
pub struct State;

Implementations

impl State

pub fn initialize( env: &mut Env<'_>, (address, contract_state): (&Address, &mut VariableBytes<RECOMMENDED_STATE_CAPACITY>), state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, ) -> Result<(), ContractError>

Initialize state.

Similar to State::write(), but returns error if the state is not empty.

pub fn write( env: &mut Env<'_>, (address, state): (&Address, &mut VariableBytes<RECOMMENDED_STATE_CAPACITY>), new_state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, ) -> Result<(), ContractError>

Write state.

Only direct caller is allowed to write its own state for security reasons.

pub fn compare_and_write( env: &mut Env<'_>, (address, state): (&Address, &mut VariableBytes<RECOMMENDED_STATE_CAPACITY>), old_state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, new_state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, ) -> Result<bool, ContractError>

Compare state with a given old state and write new state if old state matches.

Only direct caller is allowed to write its own state for security reasons.

Returns boolean indicating whether write happened or not.

pub fn read( contract_state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, state: &mut VariableBytes<RECOMMENDED_STATE_CAPACITY>, ) -> Result<(), ContractError>

Read state

pub fn is_empty( contract_state: &VariableBytes<RECOMMENDED_STATE_CAPACITY>, ) -> bool

Check if the state is empty

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Contract for State

const MAIN_CONTRACT_METADATA: &[u8]

Main contract metadata, see ContractMetadataKind for encoding details.

type Slot = VariableBytes<RECOMMENDED_STATE_CAPACITY>

Slot type used by this contract

type Tmp = ()

Tmp type used by this contract

fn code() -> impl Deref<Target = VariableBytes<{ ::ab_contracts_macros::__private::MAX_CODE_SIZE }>>

Something that can be used as “code” in native execution environment and primarily used for testing.

impl Debug for State

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

Formats the value using the given formatter.

impl TrivialType for State

const METADATA: &[u8]

Data structure metadata in binary form, describing shape and types of the contents, see [IoTypeMetadataKind] for encoding details.

const SIZE: u32 = _

unsafe fn from_bytes(bytes: &[u8]) -> Option<&Self>

Create a reference to a type, which is represented by provided memory.

unsafe fn from_bytes_mut(bytes: &mut [u8]) -> Option<&mut Self>

Create a mutable reference to a type, which is represented by provided memory.

fn as_bytes(&self) -> &[u8]

Access the underlying byte representation of a data structure

unsafe fn as_bytes_mut(&mut self) -> &mut [u8]

Access the underlying mutable byte representation of a data structure.

impl Copy for State