Skip to main content

ProgramBuilder

Struct ProgramBuilder 

Source
pub struct ProgramBuilder<R: RoleId, M> { /* private fields */ }
Expand description

Builder for choreographic programs that enforces structural invariants.

Implementations§

Source§

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

Source

pub fn new() -> Self

Create a new empty builder.

Source

pub fn try_send(self, to: R, msg: M) -> Result<Self, ProgramError>

Fallible send.

Source

pub fn send(self, to: R, msg: M) -> Self

Add a send effect.

Source

pub fn try_recv<T: 'static>(self, from: R) -> Result<Self, ProgramError>

Fallible recv.

Source

pub fn recv<T: 'static>(self, from: R) -> Self

Add a receive effect.

Source

pub fn try_choose( self, at: R, label: <R as RoleId>::Label, ) -> Result<Self, ProgramError>

Fallible choose.

Source

pub fn choose(self, at: R, label: <R as RoleId>::Label) -> Self

Add a choice effect.

Source

pub fn try_offer(self, from: R) -> Result<Self, ProgramError>

Fallible offer.

Source

pub fn offer(self, from: R) -> Self

Add an offer effect.

Source

pub fn try_with_timeout( self, at: R, dur: Duration, body: Program<R, M>, ) -> Result<Self, ProgramError>

Fallible with_timeout.

Source

pub fn with_timeout(self, at: R, dur: Duration, body: Program<R, M>) -> Self

Add a timeout effect.

Source

pub fn with_timed_choice( self, at: R, dur: Duration, body: Program<R, M>, on_timeout: Program<R, M>, ) -> Self

Add a timed choice effect - races body against timeout.

If body completes before timeout, executes body. If timeout fires first, executes on_timeout instead. This is the effect-level representation of timed_choice syntax.

Source

pub fn try_parallel( self, programs: Vec<Program<R, M>>, ) -> Result<Self, ProgramError>

Add a parallel composition effect.

Source

pub fn parallel(self, programs: Vec<Program<R, M>>) -> Self

Add a parallel composition effect.

Source

pub fn try_branch( self, choosing_role: R, branches: Vec<(<R as RoleId>::Label, Program<R, M>)>, ) -> Result<Self, ProgramError>

Add a branch effect with multiple labeled continuations.

Source

pub fn branch( self, choosing_role: R, branches: Vec<(<R as RoleId>::Label, Program<R, M>)>, ) -> Self

Add a branch effect with multiple labeled continuations.

Source

pub fn try_loop_n( self, iterations: usize, body: Program<R, M>, ) -> Result<Self, ProgramError>

Add a loop effect.

Source

pub fn loop_n(self, iterations: usize, body: Program<R, M>) -> Self

Add a loop effect.

Source

pub fn try_loop_inf(self, body: Program<R, M>) -> Result<Self, ProgramError>

Add an infinite loop effect (or until break).

Source

pub fn loop_inf(self, body: Program<R, M>) -> Self

Add an infinite loop effect (or until break).

Source

pub fn try_ext<E: ExtensionEffect<R> + 'static>( self, extension: E, ) -> Result<Self, ProgramError>

Add a domain-specific extension effect.

Source

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

Add a domain-specific extension effect.

Source

pub fn try_exts<E: ExtensionEffect<R> + 'static>( self, extensions: impl IntoIterator<Item = E>, ) -> Result<Self, ProgramError>

Add multiple extension effects.

Source

pub fn exts<E: ExtensionEffect<R> + 'static>( self, extensions: impl IntoIterator<Item = E>, ) -> Self

Add multiple extension effects.

Source

pub fn end(self) -> Program<R, M>

Mark the end of the program and finalize it.

Prefer ProgramBuilder::try_end for fallible construction.

Source

pub fn try_end(self) -> Result<Program<R, M>, ProgramError>

Fallible variant of ProgramBuilder::end.

Source

pub fn build(self) -> Result<Program<R, M>, ProgramError>

Validate and build the program without appending End.

Trait Implementations§

Source§

impl<R: Clone + RoleId, M: Clone> Clone for ProgramBuilder<R, M>

Source§

fn clone(&self) -> ProgramBuilder<R, M>

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 ProgramBuilder<R, M>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<R: RoleId, M> Default for ProgramBuilder<R, M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<R, M> Freeze for ProgramBuilder<R, M>

§

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

§

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

§

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

§

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

§

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

§

impl<R, M> !UnwindSafe for ProgramBuilder<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,