Struct soroban_env_host::ScValObject

pub struct ScValObject(/* private fields */);

ScValObject (and its reference-based type ScValObjRef) is a small wrapper type that does not have its own XDR definition, it just denotes (as a type) the subset of ScVal values that need to be represented in Val by one of the cases that can be an Object. In other words Val::try_from_val(&v, e).is_object() will be true iff ScValObject::classify(v) is Ok(ScValObject(v)).

Implementations

impl ScValObject

pub fn classify(value: ScVal) -> Result<ScValObject, ScVal>

Inspect the provided value and return Ok(ScValObject(value)) if it is a value that should be represented as an object, else Err(value).

pub unsafe fn unchecked_from_val(value: ScVal) -> ScValObject

Assert that value is the sort of value that should be ScValObject without actually inspecting its value.

Trait Implementations

impl AsRef<ScVal> for ScValObject

fn as_ref(&self) -> &ScVal

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

impl Clone for ScValObject

fn clone(&self) -> ScValObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Convert<&Object, ScValObject> for Host

type Error = HostError

fn convert(&self, ob: &Object) -> Result<ScValObject, Self::Error>

impl Convert<Object, ScValObject> for Host

type Error = HostError

fn convert(&self, ob: Object) -> Result<ScValObject, Self::Error>

impl Debug for ScValObject

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

Formats the value using the given formatter.

impl From<ScValObject> for ScVal

fn from(value: ScValObject) -> ScVal

Converts to this type from the input type.

impl Hash for ScValObject

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for ScValObject

fn cmp(&self, other: &ScValObject) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ScValObject

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

fn partial_cmp(&self, other: &ScValObject) -> 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> TryFromVal<E, Object> for ScValObject

where E: Env + Convert<Object, ScValObject>,

type Error = <E as Convert<Object, ScValObject>>::Error

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

impl Eq for ScValObject

impl StructuralEq for ScValObject

impl StructuralPartialEq for ScValObject