Skip to main content

EffectOutcome

telltale_machine

Struct EffectOutcome

pub struct EffectOutcome {
    pub status: EffectOutcomeStatus,
    pub response: Option<EffectResponse>,
}

Expand description

One typed runtime effect outcome.

Fields§

§status: EffectOutcomeStatus

Status for this outcome.

§response: Option<EffectResponse>

Typed response payload when status is success.

Implementations§

impl EffectOutcome

pub fn success(response: EffectResponse) -> Self

Construct a successful typed effect outcome.

pub fn blocked() -> Self

Construct a blocked typed effect outcome.

pub fn failure(failure: EffectFailure) -> Self

Construct a failed typed effect outcome.

pub fn into_send_decision( self, ) -> Result<EffectResult<SendDecision>, EffectFailure>

Convert this outcome into a typed EffectResult<SendDecision>.

§Errors

Returns EffectFailure when the outcome is a success with the wrong response kind or a malformed successful payload.

pub fn into_unit( self, expected_kind: &str, ) -> Result<EffectResult<()>, EffectFailure>

Convert this outcome into a typed EffectResult<()> for unit-like effects.

§Errors

Returns EffectFailure when the outcome is a success with the wrong response kind or a malformed successful payload.

pub fn into_label(self) -> Result<EffectResult<String>, EffectFailure>

Convert this outcome into a typed EffectResult<String>.

§Errors

Returns EffectFailure when the outcome is a success with the wrong response kind or a malformed successful payload.

pub fn into_value( self, expected_kind: &str, ) -> Result<EffectResult<Value>, EffectFailure>

Convert this outcome into a typed EffectResult<Value>.

§Errors

Returns EffectFailure when the outcome is a success with the wrong response kind or a malformed successful payload.

pub fn into_topology( self, ) -> Result<EffectResult<Vec<TopologyPerturbation>>, EffectFailure>

Convert this outcome into a typed EffectResult<Vec<TopologyPerturbation>>.

§Errors

Returns EffectFailure when the outcome is a success with the wrong response kind or a malformed successful payload.

pub fn into_output_condition_hint( self, ) -> Result<Option<OutputConditionHint>, EffectFailure>

Convert this outcome into an output-condition hint.

§Errors

Returns EffectFailure when the outcome blocks, fails, or carries the wrong response kind.

Trait Implementations§

impl Clone for EffectOutcome

fn clone(&self) -> EffectOutcome

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for EffectOutcome

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for EffectOutcome

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for EffectOutcome

fn eq(&self, other: &EffectOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for EffectOutcome

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for EffectOutcome

Auto Trait Implementations§

impl Freeze for EffectOutcome

impl RefUnwindSafe for EffectOutcome

impl Send for EffectOutcome

impl Sync for EffectOutcome

impl Unpin for EffectOutcome

impl UnsafeUnpin for EffectOutcome

impl UnwindSafe for EffectOutcome

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

fn lossy_into(self) -> Dst

Performs the conversion.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T> StrictAs for T

fn strict_as<Dst>(self) -> Dst
where T: StrictCast<Dst>,

Casts the value.

impl<Src, Dst> StrictCastFrom<Src> for Dst
where Src: StrictCast<Dst>,

fn strict_cast_from(src: Src) -> Dst

Casts the value.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,