Struct soroban_env_guest::Object

pub struct Object(_);

Wrapper for a RawVal that is tagged with Tag::Object, interpreting the RawVal’s body as a pair of a 28-bit object-type code and a 32-bit handle to a host object of the object-type. The object-type codes correspond to the enumerated cases of ScObject, and the handle values are dynamically assigned by the host as new objects are allocated during execution.

Implementations

impl Object

pub const fn as_raw(&self) -> &RawVal

pub const fn to_raw(&self) -> RawVal

pub fn in_env<E>(self, env: &E) -> EnvVal<E, Object>where
    E: Env,

impl Object

pub const fn is_obj_type(&self, ty: ScObjectType) -> bool

pub const fn get_handle(&self) -> u32

pub fn val_is_obj_type(v: RawVal, ty: ScObjectType) -> bool

pub fn from_type_and_handle(ty: ScObjectType, handle: u32) -> Object

Trait Implementations

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 AsMut<RawVal> for Object

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

Converts this type into a mutable 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 AsRef<RawVal> for Object

fn as_ref(&self) -> &RawVal

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

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

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 From<Object> for RawVal

fn from(b: Object) -> RawVal

Converts to this type from the input type.

impl<E> IntoVal<E, RawVal> for &Objectwhere
    E: Env,

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

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

impl<E> IntoVal<E, RawVal> for Objectwhere
    E: Env,

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

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

impl RawValConvertible for Object

fn is_val_type(v: RawVal) -> bool

Returns true if v is in a union state compatible with Self.

unsafe fn unchecked_from_val(v: RawVal) -> Object

Converts the bits making up a RawVal into Self without checking that the RawVal is tagged correctly, assuming that such a check has been performed elsewhere. It is the caller’s responsibility to arrange that such checks have occurred before calling unchecked_from_val, which is why it is marked as unsafe (it does not represent a risk of memory-unsafety, merely “serious logic errors”).

fn try_convert(v: RawVal) -> Option<Self>

Attempt a conversion from RawVal to Self, returning None if the provided RawVal is not tagged correctly. By default this calls Self::is_val_type and Self::unchecked_from_val, but it can be customized on a type-by-type basis to avoid redundant tag tests and produce more efficient code, as it is done for Static values like bool.

impl TryFrom<&RawVal> for Object

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: &RawVal) -> Result<Object, <Object as TryFrom<&RawVal>>::Error>

Performs the conversion.

impl TryFrom<RawVal> for Object

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(v: RawVal) -> Result<Object, <Object as TryFrom<RawVal>>::Error>

Performs the conversion.

impl<E> TryFromVal<E, Object> for ScObjectwhere
    E: Env + TryConvert<Object, ScObject>,

type Error = <E as TryConvert<Object, ScObject>>::Error

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

impl<E> TryFromVal<E, RawVal> for Objectwhere
    E: Env,

type Error = ConversionError

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

impl<'a, E> TryIntoVal<E, Object> for &'a ScObjectwhere
    E: Env + TryConvert<&'a ScObject, Object>,

type Error = <E as TryConvert<&'a ScObject, Object>>::Error

fn try_into_val(
    self,
    env: &E
) -> Result<Object, <&'a ScObject as TryIntoVal<E, Object>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<'a, E> TryIntoVal<E, Object> for &'a ScValwhere
    E: Env + TryConvert<&'a ScObject, Object>,

type Error = <E as TryConvert<&'a ScObject, Object>>::Error

fn try_into_val(
    self,
    env: &E
) -> Result<Object, <&'a ScVal as TryIntoVal<E, Object>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<E> TryIntoVal<E, Object> for RawValwhere
    E: Env,

type Error = ConversionError

fn try_into_val(
    self,
    env: &E
) -> Result<Object, <RawVal as TryIntoVal<E, Object>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<E> TryIntoVal<E, Object> for ScObjectwhere
    E: Env + TryConvert<ScObject, Object>,

type Error = <E as TryConvert<ScObject, Object>>::Error

fn try_into_val(
    self,
    env: &E
) -> Result<Object, <ScObject as TryIntoVal<E, Object>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<E> TryIntoVal<E, Object> for ScValwhere
    E: Env + TryConvert<ScObject, Object>,

type Error = <E as TryConvert<ScObject, Object>>::Error

fn try_into_val(
    self,
    env: &E
) -> Result<Object, <ScVal as TryIntoVal<E, Object>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<E> TryIntoVal<E, RawVal> for Objectwhere
    E: Env,

type Error = ConversionError

fn try_into_val(
    self,
    _env: &E
) -> Result<RawVal, <Object as TryIntoVal<E, RawVal>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl Copy for Object

impl Val for Object