Skip to main content

Effect

Enum Effect 

Source
pub enum Effect<R: RoleId, M> {
    Send {
        to: R,
        msg: M,
    },
    Recv {
        from: R,
        msg_tag: MessageTag,
    },
    Choose {
        at: R,
        label: <R as RoleId>::Label,
    },
    Offer {
        from: R,
    },
    Branch {
        choosing_role: R,
        branches: Vec<(<R as RoleId>::Label, Program<R, M>)>,
    },
    Loop {
        iterations: Option<usize>,
        body: Box<Program<R, M>>,
    },
    Timeout {
        at: R,
        dur: Duration,
        body: Box<Program<R, M>>,
        on_timeout: Option<Box<Program<R, M>>>,
    },
    Parallel {
        programs: Vec<Program<R, M>>,
    },
    Extension(Box<dyn ExtensionEffect<R>>),
    End,
}
Expand description

A choreographic effect that can be performed by a role

Variants§

§

Send

Send a message to another role

Fields

§to: R
§msg: M
§

Recv

Receive a message from another role

Fields

§from: R
§msg_tag: MessageTag
§

Choose

Make an internal choice and broadcast the label

Fields

§at: R
§label: <R as RoleId>::Label
§

Offer

Wait for an external choice from another role

Fields

§from: R
§

Branch

Branch based on a choice - includes all possible continuations The choosing role has already selected via Choose effect Other roles use Offer to receive the label, then select matching branch

Fields

§choosing_role: R
§branches: Vec<(<R as RoleId>::Label, Program<R, M>)>
§

Loop

Loop that executes body a fixed number of times or until a condition

Fields

§iterations: Option<usize>

Number of iterations (None = infinite/until break)

§body: Box<Program<R, M>>
§

Timeout

Execute a sub-program with a timeout

If on_timeout is Some, executes that program when timeout occurs. Otherwise, the handler decides what to do on timeout (typically error).

Fields

§at: R
§body: Box<Program<R, M>>
§on_timeout: Option<Box<Program<R, M>>>

Optional fallback program to execute if timeout occurs

§

Parallel

Execute multiple programs using deterministic normalized ordering.

The interpreter executes sub-programs in declaration order. This keeps behavior reproducible across runtimes while preserving the high-level “parallel composition” intent.

Fields

§programs: Vec<Program<R, M>>
§

Extension(Box<dyn ExtensionEffect<R>>)

Extension effect for domain-specific operations

Extensions are boxed trait objects that implement ExtensionEffect. Use Effect::ext() or Program::ext() for construction.

§Type Safety

Extensions are identified by TypeId and use trait object downcasting for type-safe access. Unknown extensions cause runtime errors (fail-fast).

§Projection

Extensions project based on participating_roles():

  • Empty roles → appears in all projections
  • Non-empty → appears only in specified role projections
§

End

End of program

Implementations§

Source§

impl<R: RoleId, M> Effect<R, M>

Extension effect helper methods

Source

pub fn ext<E: ExtensionEffect<R> + 'static>(extension: E) -> Self

Create an extension effect from any type implementing ExtensionEffect

Source

pub fn is_extension<E: ExtensionEffect<R> + 'static>(&self) -> bool

Check if this is an extension effect of a specific type

Source

pub fn as_extension<E: ExtensionEffect<R> + 'static>(&self) -> Option<&E>

Extract extension data with type checking

Returns Some(&E) if this is an extension of type E, None otherwise.

Source

pub fn as_extension_mut<E: ExtensionEffect<R> + 'static>( &mut self, ) -> Option<&mut E>

Extract mutable extension data with type checking

Source

pub fn extension_type_id(&self) -> Option<TypeId>

Get the TypeId of an extension effect

Trait Implementations§

Source§

impl<R: RoleId, M: Clone> Clone for Effect<R, M>

Source§

fn clone(&self) -> Self

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
Source§

impl<R: Debug + RoleId, M: Debug> Debug for Effect<R, M>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R, M> Freeze for Effect<R, M>
where R: Freeze, M: Freeze, <R as RoleId>::Label: Freeze,

§

impl<R, M> !RefUnwindSafe for Effect<R, M>

§

impl<R, M> Send for Effect<R, M>
where M: Send,

§

impl<R, M> Sync for Effect<R, M>
where M: Sync,

§

impl<R, M> Unpin for Effect<R, M>
where R: Unpin, M: Unpin, <R as RoleId>::Label: Unpin,

§

impl<R, M> UnsafeUnpin for Effect<R, M>

§

impl<R, M> !UnwindSafe for Effect<R, M>

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> Az for T

Source§

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

Casts the value.
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<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

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

Casts the value.
Source§

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

Source§

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

Casts the value.
Source§

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

Source§

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
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<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

Source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
Source§

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

Source§

fn lossy_into(self) -> Dst

Performs the conversion.
Source§

impl<T> OverflowingAs for T

Source§

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

Casts the value.
Source§

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

Source§

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

Casts the value.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatingAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> StrictAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn strict_cast_from(src: Src) -> Dst

Casts the value.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

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

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

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<T> UnwrappedAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
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
Source§

impl<T> WrappingAs for T

Source§

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

Casts the value.
Source§

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

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> Endpoint for T
where T: Send,

Source§

impl<T> ProgramMessage for T
where T: Clone + Send + Sync + Debug,