Enum RiverResult 

pub enum RiverResult<T, E: ToString> {
    Ok(T),
    Err {
        message: String,
        code: E,
    },
}

Result type used by the River protocol.

To serialize this enum, or use it in a message it needs to be converted to a RiverResultInternal using Into::into.

The reason for why this is needed is given in the documentation page for the result module.

Variants

Ok(T)

Contains the success value

Err

Contains the error value

Fields

message: String

The associated error message

code: E

The error code

Implementations

impl<T, E: ToString> RiverResult<T, E>

pub const fn is_ok(&self) -> bool

Returns true if the result is Ok.

pub const fn is_err(&self) -> bool

Returns true if the result is Err.

Trait Implementations

impl<T: Clone, E: Clone + ToString> Clone for RiverResult<T, E>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug + ToString> Debug for RiverResult<T, E>

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

Formats the value using the given formatter.

impl<T, E: ToString> From<RiverResult<T, E>> for RiverResultInternal<T>

fn from(result: RiverResult<T, E>) -> Self

Converts to this type from the input type.

impl<T, E: TryFrom<String, Error = E2> + ToString, E2: Display> TryFrom<RiverResultInternal<T>> for RiverResult<T, E>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(result: RiverResultInternal<T>) -> Result<Self, Self::Error>

Performs the conversion.