Enum multiversx_sc::types::SCResult

pub enum SCResult<T, E = StaticSCError> {
    Ok(T),
    Err(E),
}

Default way to optionally return an error from a smart contract endpoint.

Variants

Ok(T)

Err(E)

Implementations

impl<T, E> SCResult<T, E>

pub fn is_ok(&self) -> bool

pub fn is_err(&self) -> bool

pub fn ok(self) -> Option<T>

pub fn err(self) -> Option<E>

pub fn unwrap_or_signal_error<FA: EndpointFinishApi>(self) -> Twhere E: SCError,

Returns the contained Ok value or signals the error and exits.

pub fn from_result<FromErr>(r: Result<T, FromErr>) -> Selfwhere FromErr: Into<E>,

Used to convert from a regular Rust result. Any error type is accepted as long as it can be converted to a SCError (Vec<u8>, &[u8], BoxedBytes, String, &str are covered).

impl<T> SCResult<T>

pub fn unwrap(self) -> T

Trait Implementations

impl<T: Clone, E: Clone> Clone for SCResult<T, E>

fn clone(&self) -> SCResult<T, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for SCResult<T, E>

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

Formats the value using the given formatter.

impl<T, Err> From<Result<T, Err>> for SCResult<T>where Err: Into<StaticSCError>,

fn from(result: Result<T, Err>) -> Self

Converts to this type from the input type.

impl<T> From<SCResult<T, StaticSCError>> for Result<T, StaticSCError>

fn from(result: SCResult<T>) -> Self

Converts to this type from the input type.

impl<T, E> FromResidual<<SCResult<T, E> as Try>::Residual> for SCResult<T, E>

fn from_residual(r: E) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl<T, FromErr> FromResidual<Result<Infallible, FromErr>> for SCResult<T>where FromErr: Into<StaticSCError>,

fn from_residual(residual: Result<Infallible, FromErr>) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl<T: PartialEq, E: PartialEq> PartialEq<SCResult<T, E>> for SCResult<T, E>

fn eq(&self, other: &SCResult<T, E>) -> 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<T, E> TopEncodeMulti for SCResult<T, E>where T: TopEncodeMulti, E: TopEncodeMulti,

fn multi_encode_or_handle_err<O, H>( &self, output: &mut O, h: H ) -> Result<(), H::HandledErr>where O: TopEncodeMultiOutput, H: EncodeErrorHandler,

Version of top_encode that can handle errors as soon as they occur. For instance in can exit immediately and make sure that if it returns, it is a success. By not deferring error handling, this can lead to somewhat smaller bytecode.

fn multi_encode<O>(&self, output: &mut O) -> Result<(), EncodeError>where O: TopEncodeMultiOutput,

Attempt to serialize the value to ouput.

impl<T, E> Try for SCResult<T, E>

Implementing the Try trait overloads the ? operator. Documentation on the new version of the trait: https://github.com/scottmcm/rfcs/blob/do-or-do-not/text/0000-try-trait-v2.md#the-try-trait

type Output = T

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value produced by ? when not short-circuiting.

type Residual = E

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value passed to FromResidual::from_residual as part of ? when short-circuiting.

fn branch(self) -> ControlFlow<Self::Residual, T>

🔬This is a nightly-only experimental API. (try_trait_v2)

Used in ? to decide whether the operator should produce a value (because this returned ControlFlow::Continue) or propagate a value back to the caller (because this returned ControlFlow::Break).

fn from_output(v: T) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from its Output type.

impl<T: TypeAbi, E> TypeAbi for SCResult<T, E>

fn type_name() -> TypeName

fn provide_type_descriptions<TDC: TypeDescriptionContainer>( accumulator: &mut TDC )

A type can provide more than its own description. For instance, a struct can also provide the descriptions of the type of its fields. TypeAbi doesn’t care for the exact accumulator type, which is abstracted by the TypeDescriptionContainer trait.

impl<T: Eq, E: Eq> Eq for SCResult<T, E>

impl<T, E> StructuralEq for SCResult<T, E>

impl<T, E> StructuralPartialEq for SCResult<T, E>