Skip to main content

ActionOutcome

Struct ActionOutcome 

Source
pub struct ActionOutcome {
    pub input: DataId,
    pub goal: GoalId,
    pub status: GoalStatus,
    pub metadata: Metadata,
    pub payload: Payload,
}
Expand description

One status update, as a client or server sees it.

Fields§

§input: DataId

The input it arrived on.

§goal: GoalId

The goal it concerns.

§status: GoalStatus

The status it reports.

§metadata: Metadata

Its metadata.

§payload: Payload

The payload — a result for a terminal status, feedback otherwise.

Implementations§

Source§

impl ActionOutcome

Source

pub fn from_event(event: Event) -> Result<Self, Box<Event>>

Reads a status update out of an event, if it is one.

An input with a goal_id but no goal_status is the goal itself (what a server receives), not an update; it is returned unchanged so a server can handle it with ActionOutcome::goal_of.

Source

pub fn goal_of(event: &Event) -> Option<GoalId>

The goal id of an event that carries one, whether or not it is a status update.

Source

pub fn is_terminal(&self) -> bool

Whether this update ends the goal.

Source

pub fn is_feedback(&self) -> bool

Whether this update is feedback rather than an outcome.

Source

pub fn view<T: FromPayload>(&self) -> Result<T>

Decodes the payload.

§Errors

NodeError::Data when the payload is not a T.

Trait Implementations§

Source§

impl Debug for ActionOutcome

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more