Skip to main content

JoinTarget

Struct JoinTarget 

Source
pub struct JoinTarget<T: TaskNode<Input = JoinInput<Payload>> + ?Sized, Payload: NodeArg> { /* private fields */ }
Expand description

A configured join destination for branches that should converge into a join node.

Build a JoinTarget from a join node with NodeId::join, and then register it through Task::register_transition. Users normally do not construct this type directly.

Implementations§

Source§

impl<T, Payload> JoinTarget<T, Payload>
where T: TaskNode<Input = JoinInput<Payload>> + ?Sized, Payload: NodeArg,

Source

pub fn map<F>(self, map: F) -> MappedJoinTarget<T, Payload, F>
where F: Send + Sync + 'static,

Maps each joining branch output into the payload stored for the join node.

§Examples
use swiftide_tasks::{JoinInput, NodeError, Task, Transition};

let mut task = Task::<i32, i32>::new();
let start = task.register_node_fn(|input: &i32| -> Result<i32, NodeError> { Ok(*input) });
let branch = task.register_node_fn(|input: &i32| -> Result<i32, NodeError> { Ok(*input + 1) });
let join = task.register_node_fn(|input: &JoinInput<i32>| -> Result<i32, NodeError> {
    Ok(input.iter().copied().sum())
});

task.starts_with(start);
task.register_transition(start, move |value| {
    Transition::fan_out(&branch, value)
        .join_with(join.join())
})?;
task.register_transition(branch, join.join().map(|value| value * 2))?;
Source

pub fn map_async<F>(self, map: F) -> MappedJoinTarget<T, Payload, F>
where F: Send + Sync + 'static,

Maps each joining branch output asynchronously before storing it for the join node.

§Examples
use swiftide_tasks::{JoinInput, NodeError, Task, Transition};

let mut task = Task::<i32, i32>::new();
let start = task.register_node_fn(|input: &i32| -> Result<i32, NodeError> { Ok(*input) });
let branch = task.register_node_fn(|input: &i32| -> Result<i32, NodeError> { Ok(*input + 1) });
let join = task.register_node_fn(|input: &JoinInput<i32>| -> Result<i32, NodeError> {
    Ok(input.iter().copied().sum())
});

task.starts_with(start);
task.register_transition(start, move |value| {
    Transition::fan_out(&branch, value)
        .join_with(join.join())
})?;
task.register_transition_async(branch, join.join().map_async(|value| async move { value * 2 }))?;

Auto Trait Implementations§

§

impl<T, Payload> !Send for JoinTarget<T, Payload>

§

impl<T, Payload> !Sync for JoinTarget<T, Payload>

§

impl<T, Payload> Forget for JoinTarget<T, Payload>
where T: ?Sized,

§

impl<T, Payload> Freeze for JoinTarget<T, Payload>
where PhantomData<(*const T, Payload)>: Freeze, T: ?Sized,

§

impl<T, Payload> RefUnwindSafe for JoinTarget<T, Payload>
where PhantomData<(*const T, Payload)>: RefUnwindSafe, T: ?Sized,

§

impl<T, Payload> Unpin for JoinTarget<T, Payload>
where PhantomData<(*const T, Payload)>: Unpin, T: ?Sized,

§

impl<T, Payload> UnsafeUnpin for JoinTarget<T, Payload>
where PhantomData<(*const T, Payload)>: UnsafeUnpin, T: ?Sized,

§

impl<T, Payload> UnwindSafe for JoinTarget<T, Payload>
where PhantomData<(*const T, Payload)>: UnwindSafe, T: ?Sized,

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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