Struct soroban_env_host::EnvVal

pub struct EnvVal<E, V>where
    E: Env,{
    pub env: E,
    pub val: V,
}

Some type of value coupled to a specific instance of Env, which some of the value’s methods may call into to support some conversion and comparison functions.

The value and Env instance used in an EnvVal will vary by context:

• In contract code compiled for WASM, the Env is a zero-sized Guest struct
• In contract code compiled natively for local testing, the Env is a reference-counted Host
• Inside the Host, the Env is either a Host or a weak reference to a Host

The value will typically either be RawVal or one of its tag-specific wrapper types.

Fields

env: E

The environment to call into for comparison and conversion assistance.

val: V

The value that will call into the environment as needed.

Implementations

impl<E> EnvVal<E, BitSet>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

impl<E, V> EnvVal<E, V>where
    E: Env,
    V: Val,

pub fn env(&self) -> &E

impl<E> EnvVal<E, RawVal>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

impl<E> EnvVal<E, Object>where
    E: Env,

pub fn as_object(&self) -> &Object

pub fn to_object(&self) -> Object

impl<E> EnvVal<E, Object>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

impl<E> EnvVal<E, Static>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

impl<E> EnvVal<E, Status>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

impl<E> EnvVal<E, Symbol>where
    E: Env,

pub fn as_raw(&self) -> &RawVal

pub fn to_raw(&self) -> RawVal

Trait Implementations

impl<E> AsMut<BitSet> for EnvVal<E, BitSet>where
    E: Env,

fn as_mut(&mut self) -> &mut BitSet

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsMut<Object> for EnvVal<E, Object>where
    E: Env,

fn as_mut(&mut self) -> &mut Object

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E, V> AsMut<RawVal> for EnvVal<E, V>where
    E: Env,
    V: Val,

fn as_mut(&mut self) -> &mut RawVal

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsMut<Static> for EnvVal<E, Static>where
    E: Env,

fn as_mut(&mut self) -> &mut Static

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsMut<Status> for EnvVal<E, Status>where
    E: Env,

fn as_mut(&mut self) -> &mut Status

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsMut<Symbol> for EnvVal<E, Symbol>where
    E: Env,

fn as_mut(&mut self) -> &mut Symbol

Converts this type into a mutable reference of the (usually inferred) input type.

impl<E> AsRef<BitSet> for EnvVal<E, BitSet>where
    E: Env,

fn as_ref(&self) -> &BitSet

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> AsRef<Object> for EnvVal<E, Object>where
    E: Env,

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.

impl<E, V> AsRef<RawVal> for EnvVal<E, V>where
    E: Env,
    V: Val,

fn as_ref(&self) -> &RawVal

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> AsRef<Static> for EnvVal<E, Static>where
    E: Env,

fn as_ref(&self) -> &Static

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> AsRef<Status> for EnvVal<E, Status>where
    E: Env,

fn as_ref(&self) -> &Status

Converts this type into a shared reference of the (usually inferred) input type.

impl<E> AsRef<Symbol> for EnvVal<E, Symbol>where
    E: Env,

fn as_ref(&self) -> &Symbol

Converts this type into a shared reference of the (usually inferred) input type.

impl<E, V> Clone for EnvVal<E, V>where
    E: Clone + Env,
    V: Clone,

fn clone(&self) -> EnvVal<E, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, V> Debug for EnvVal<E, V>where
    E: Env + Debug,

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

Formats the value using the given formatter.

impl<E> From<EnvVal<E, BitSet>> for BitSetwhere
    E: Env,

fn from(ev: EnvVal<E, BitSet>) -> BitSet

Converts to this type from the input type.

impl<E> From<EnvVal<E, BitSet>> for EnvVal<E, RawVal>where
    E: Env,

fn from(ev: EnvVal<E, BitSet>) -> EnvVal<E, RawVal>

Converts to this type from the input type.

impl<E> From<EnvVal<E, BitSet>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, BitSet>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, Object>> for EnvVal<E, RawVal>where
    E: Env,

fn from(ev: EnvVal<E, Object>) -> EnvVal<E, RawVal>

Converts to this type from the input type.

impl<E> From<EnvVal<E, Object>> for Objectwhere
    E: Env,

fn from(ev: EnvVal<E, Object>) -> Object

Converts to this type from the input type.

impl<E> From<EnvVal<E, Object>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, Object>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, RawVal>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, RawVal>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, Static>> for EnvVal<E, RawVal>where
    E: Env,

fn from(ev: EnvVal<E, Static>) -> EnvVal<E, RawVal>

Converts to this type from the input type.

impl<E> From<EnvVal<E, Static>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, Static>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, Static>> for Staticwhere
    E: Env,

fn from(ev: EnvVal<E, Static>) -> Static

Converts to this type from the input type.

impl<E> From<EnvVal<E, Status>> for EnvVal<E, RawVal>where
    E: Env,

fn from(ev: EnvVal<E, Status>) -> EnvVal<E, RawVal>

Converts to this type from the input type.

impl<E> From<EnvVal<E, Status>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, Status>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, Status>> for Statuswhere
    E: Env,

fn from(ev: EnvVal<E, Status>) -> Status

Converts to this type from the input type.

impl<E> From<EnvVal<E, Symbol>> for EnvVal<E, RawVal>where
    E: Env,

fn from(ev: EnvVal<E, Symbol>) -> EnvVal<E, RawVal>

Converts to this type from the input type.

impl<E> From<EnvVal<E, Symbol>> for RawValwhere
    E: Env,

fn from(ev: EnvVal<E, Symbol>) -> RawVal

Converts to this type from the input type.

impl<E> From<EnvVal<E, Symbol>> for Symbolwhere
    E: Env,

fn from(ev: EnvVal<E, Symbol>) -> Symbol

Converts to this type from the input type.

impl<E, T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,
    T7: IntoVal<E, RawVal>,
    T8: IntoVal<E, RawVal>,
    T9: IntoVal<E, RawVal>,
    T10: IntoVal<E, RawVal>,
    T11: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,
    T7: IntoVal<E, RawVal>,
    T8: IntoVal<E, RawVal>,
    T9: IntoVal<E, RawVal>,
    T10: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5, T6, T7, T8, T9> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,
    T7: IntoVal<E, RawVal>,
    T8: IntoVal<E, RawVal>,
    T9: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5, T6, T7, T8> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6, T7, T8)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,
    T7: IntoVal<E, RawVal>,
    T8: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5, T6, T7> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6, T7)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,
    T7: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5, T6> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5, T6)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,
    T6: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4, T5> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4, T5)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,
    T5: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3, T4> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3, T4)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,
    T4: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2, T3> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2, T3)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,
    T3: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1, T2> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1, T2)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,
    T2: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0, T1> IntoVal<E, EnvVal<E, RawVal>> for (T0, T1)where
    E: Env,
    T0: IntoVal<E, RawVal>,
    T1: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, T0> IntoVal<E, EnvVal<E, RawVal>> for (T0,)where
    E: Env,
    T0: IntoVal<E, RawVal>,

fn into_val(self, env: &E) -> EnvVal<E, RawVal>

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, V> IntoVal<E, V> for EnvVal<E, V>where
    E: Env,

fn into_val(self, _env: &E) -> V

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<E, V> Ord for EnvVal<E, V>where
    E: Env,
    V: Val,

fn cmp(&self, other: &EnvVal<E, V>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<E, V> PartialEq<EnvVal<E, V>> for EnvVal<E, V>where
    E: Env,
    V: Val,

fn eq(&self, other: &EnvVal<E, V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<E, V> PartialOrd<EnvVal<E, V>> for EnvVal<E, V>where
    E: Env,
    V: Val,

fn partial_cmp(&self, other: &EnvVal<E, V>) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<E, V> TryFromVal<E, V> for EnvVal<E, V>where
    E: Env,

type Error = Infallible

fn try_from_val(
    env: &E,
    val: V
) -> Result<EnvVal<E, V>, <EnvVal<E, V> as TryFromVal<E, V>>::Error>

impl<E, V> Eq for EnvVal<E, V>where
    E: Env,
    V: Val,