Struct odra::Var

pub struct Var<T> { /* private fields */ }

Data structure for storing a single value.

Implementations

impl<T> Var<T>

pub fn env(&self) -> ContractEnv

Returns the contract environment associated with the variable.

impl<T> Var<T>

where T: FromBytes,

pub fn get(&self) -> Option<T>

Retrieves the value of the variable.

Returns Some(value) if the variable has a value, or None if it is unset.

pub fn get_or_revert_with<E>(&self, error: E) -> T

where E: Into<OdraError>,

Retrieves the value of the variable or reverts with an error.

If the variable has a value, it is returned. Otherwise, the provided error is reverted.

impl<T> Var<T>

where T: FromBytes + Default,

pub fn get_or_default(&self) -> T

Returns the value of the variable, or the default value of the type if the variable is None.

impl<T> Var<T>

where T: ToBytes + CLTyped,

pub fn set(&mut self, value: T)

Sets the value of the variable.

impl<V> Var<V>

where V: ToBytes + FromBytes + CLTyped + OverflowingAdd + Default,

pub fn add(&mut self, value: V)

Utility function that gets the current value and adds the passed value and sets the new value to the storage.

If the operation fails due to overflow, the currently executing contract reverts.

impl<V> Var<V>

where V: ToBytes + FromBytes + CLTyped + OverflowingSub + Default,

pub fn subtract(&mut self, value: V)

Utility function that gets the current value and subtracts the passed value and sets the new value to the storage.

If the operation fails due to overflow, the currently executing contract reverts.

Trait Implementations

impl<T> ModuleComponent for Var<T>

Implements the ModuleComponent trait for the Var struct.

fn instance(env: Rc<ContractEnv>, index: u8) -> Var<T>

Creates a new instance of Var with the given environment and index.

impl<M> SchemaErrors for Var<M>

where M: SchemaErrors,

fn schema_errors() -> Vec<UserError>

Returns a vector of UserErrors.

impl<M> SchemaEvents for Var<M>

where M: SchemaEvents,

fn schema_events() -> Vec<Event>

Returns a vector of Events.

fn custom_types() -> Vec<Option<CustomType>>

Returns a vector of CustomTypes.

impl<T> ModulePrimitive for Var<T>