Struct soroban_env_guest::Status

pub struct Status(_);

Wrapper for a RawVal that is tagged with Tag::Status, interpreting the RawVal’s body as a pair of a 28-bit status-type code and a 32-bit status code. The status-type codes correspond to the enumerated cases of ScStatusType, and the status codes correspond to the code values stored in each variant of the ScStatus union.

Implementations

impl Status

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

pub const fn to_raw(&self) -> RawVal

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

impl Status

pub const UNKNOWN_ERROR: Status = unsafe { Status::from_major_minor(0, ScStatusType::UnknownError as u32) }

pub const OK: Status = unsafe { Status::from_major_minor(0, ScStatusType::Ok as u32) }

impl Status

pub const fn is_type(&self, ty: ScStatusType) -> bool

pub const fn get_code(&self) -> u32

pub const fn is_ok(&self) -> bool

pub const fn from_contract_error(code: u32) -> Status

pub const fn from_type_and_code(ty: ScStatusType, code: u32) -> Status

pub const fn from_status(sc: ScStatus) -> Status

Trait Implementations

impl AsMut<RawVal> for Status

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

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 AsRef<RawVal> for Status

fn as_ref(&self) -> &RawVal

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 Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl From<BitSetError> for Status

fn from(bse: BitSetError) -> Status

Converts to this type from the input type.

impl From<ConversionError> for Status

fn from(ConversionError) -> Status

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 From<Infallible> for Status

fn from(Infallible) -> Status

Converts to this type from the input type.

impl From<ScHostContextErrorCode> for Status

fn from(code: ScHostContextErrorCode) -> Status

Converts to this type from the input type.

impl From<ScHostFnErrorCode> for Status

fn from(code: ScHostFnErrorCode) -> Status

Converts to this type from the input type.

impl From<ScHostObjErrorCode> for Status

fn from(code: ScHostObjErrorCode) -> Status

Converts to this type from the input type.

impl From<ScHostStorageErrorCode> for Status

fn from(code: ScHostStorageErrorCode) -> Status

Converts to this type from the input type.

impl From<ScHostValErrorCode> for Status

fn from(code: ScHostValErrorCode) -> Status

Converts to this type from the input type.

impl From<ScStatus> for Status

fn from(st: ScStatus) -> Status

Converts to this type from the input type.

impl From<ScUnknownErrorCode> for Status

fn from(code: ScUnknownErrorCode) -> Status

Converts to this type from the input type.

impl From<ScVmErrorCode> for Status

fn from(code: ScVmErrorCode) -> Status

Converts to this type from the input type.

impl From<Status> for RawVal

fn from(b: Status) -> RawVal

Converts to this type from the input type.

impl From<SymbolError> for Status

fn from(se: SymbolError) -> Status

Converts to this type from the input type.

impl Hash for Status

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<E> IntoVal<E, RawVal> for &Statuswhere
    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 Statuswhere
    E: Env,

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

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

impl Ord for Status

fn cmp(&self, other: &Status) -> 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 PartialEq<Status> for Status

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

fn partial_cmp(&self, other: &Status) -> 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 RawValConvertible for Status

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) -> Status

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 Status

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RawVal> for Status

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Status> for ScStatus

type Error = Error

The type returned in the event of a conversion error.

fn try_from(
    st: Status
) -> Result<ScStatus, <ScStatus as TryFrom<Status>>::Error>

Performs the conversion.

impl TryFrom<Status> for ScVal

type Error = Error

The type returned in the event of a conversion error.

fn try_from(st: Status) -> Result<ScVal, <ScVal as TryFrom<Status>>::Error>

Performs the conversion.

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

type Error = ConversionError

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

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

type Error = ConversionError

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

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

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

type Error = ConversionError

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

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

impl Copy for Status

impl Eq for Status

impl Val for Status