Struct async_nursery::Nursery[−][src]

pub struct Nursery<S, Out> { /* fields omitted */ }

Expand description

The sender part of the nursery. Wraps an unbounded sender. Can be cloned. To manage the spawned tasks and await their output, see NurseryStream.

Will disconnect on drop. You can close all senders by calling close_nursery.

Implementations

impl<S, Out> Nursery<S, Out>[src]

pub fn new(spawner: S) -> (Self, NurseryStream<Out>) where
    Out: 'static,

[src]

Create a new nursery. Returns a tuple of the sender part and the stream of outputs.

pub fn close_nursery(&self)[src]

Stop this nursery and any clones from accepting any more tasks. Calling this or dropping all Nursery is necessary for the stream impl of NurseryStream to end and return None.

Trait Implementations

impl<S, Out> Clone for Nursery<S, Out> where
    S: Clone,

[src]

fn clone(&self) -> Self[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<S: Debug, Out: Debug> Debug for Nursery<S, Out>[src]

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

Formats the value using the given formatter. Read more

impl<S, Out> LocalNurse<Out> for Nursery<S, Out> where
    S: LocalSpawnHandle<Out>,
    Out: 'static,

[src]

fn nurse_local_obj(
    &self, 
    fut: LocalFutureObj<'static, Out>
) -> Result<(), NurseErr>

[src]

Spawn a !Send future and store it’s JoinHandle.

impl<S> LocalSpawn for Nursery<S, ()> where
    S: LocalSpawnHandle<()>,

[src]

fn spawn_local_obj(
    &self, 
    fut: LocalFutureObj<'static, ()>
) -> Result<(), SpawnError>

[src]

Spawns a future that will be run to completion. Read more

fn status_local(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks. Read more

impl<S, Out> Nurse<Out> for Nursery<S, Out> where
    S: SpawnHandle<Out>,
    Out: 'static + Send,

[src]

fn nurse_obj(&self, fut: FutureObj<'static, Out>) -> Result<(), NurseErr>[src]

Spawn a future and store it’s JoinHandle.

impl<S, Out> Sink<FutureObj<'static, Out>> for Nursery<S, Out> where
    S: SpawnHandle<Out>,
    Out: 'static + Send,

[src]

fn poll_close(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

This is a no-op. If you want to disconnect, just drop this Nursery. If you want to close the NurseryStream, call Nursery::close_nursery.

type Error = NurseErr

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

Attempts to prepare the Sink to receive a value. Read more

fn start_send(
    self: Pin<&mut Self>, 
    fut: FutureObj<'static, Out>
) -> Result<(), Self::Error>

[src]

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

fn poll_flush(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

Flush any remaining output from this sink. Read more

impl<S, Out> Sink<LocalFutureObj<'static, Out>> for Nursery<S, Out> where
    S: LocalSpawnHandle<Out>,
    Out: 'static,

[src]

fn poll_close(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

This is a no-op. If you want to disconnect, just drop this Nursery. If you want to close the NurseryStream, call Nursery::close_nursery.

type Error = NurseErr

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

Attempts to prepare the Sink to receive a value. Read more

fn start_send(
    self: Pin<&mut Self>, 
    fut: LocalFutureObj<'static, Out>
) -> Result<(), Self::Error>

[src]

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more

fn poll_flush(
    self: Pin<&mut Self>, 
    _cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

[src]

Flush any remaining output from this sink. Read more

impl<S> Spawn for Nursery<S, ()> where
    S: SpawnHandle<()>,

[src]

fn spawn_obj(&self, fut: FutureObj<'static, ()>) -> Result<(), SpawnError>[src]

Spawns a future that will be run to completion. Read more

fn status(&self) -> Result<(), SpawnError>

Determines whether the executor is able to spawn new tasks. Read more

Auto Trait Implementations

impl<S, Out> !RefUnwindSafe for Nursery<S, Out>

impl<S, Out> Send for Nursery<S, Out> where
    Out: Send,
    S: Send,

impl<S, Out> Sync for Nursery<S, Out> where
    Out: Send,
    S: Sync,

impl<S, Out> Unpin for Nursery<S, Out> where
    S: Unpin,

impl<S, Out> !UnwindSafe for Nursery<S, Out>

Blanket Implementations

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

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

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

fn in_current_span(self) -> Instrumented<Self>[src]

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

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

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<Sp> LocalSpawnExt for Sp where
    Sp: LocalSpawn + ?Sized,

fn spawn_local<Fut>(&self, future: Fut) -> Result<(), SpawnError> where
    Fut: Future<Output = ()> + 'static,

Spawns a task that polls the given future with output () to completion. Read more

fn spawn_local_with_handle<Fut>(
    &self, 
    future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
    Fut: Future + 'static,

Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future’s output. Read more

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
    E: From<Self::Error>,
    Fut: Future<Output = Result<Item, E>>,
    F: FnMut(U) -> Fut,

Composes a function in front of the sink. Read more

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
    F: FnMut(U) -> St,
    St: Stream<Item = Result<Item, Self::Error>>,

Composes a function in front of the sink. Read more

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::Error) -> E,

Transforms the error returned by the sink.

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
    Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

Adds a fixed-size buffer to the current sink. Read more

fn close(&mut self) -> Close<'_, Self, Item> where
    Self: Unpin,

Close the sink.

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
    Item: Clone,
    Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

fn flush(&mut self) -> Flush<'_, Self, Item> where
    Self: Unpin,

Flush the sink, processing all pending items. Read more

fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
    Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
    Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
    Self: Unpin,
    St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<Item, Error = Self::Error>,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<Item, Error = Self::Error>,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_ready_unpin(
    &mut self, 
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin,

A convenience method for calling [Sink::poll_ready] on Unpin sink types. Read more

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
    Self: Unpin,

A convenience method for calling [Sink::start_send] on Unpin sink types. Read more

fn poll_flush_unpin(
    &mut self, 
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin,

A convenience method for calling [Sink::poll_flush] on Unpin sink types. Read more

fn poll_close_unpin(
    &mut self, 
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin,

A convenience method for calling [Sink::poll_close] on Unpin sink types. Read more

impl<Sp> SpawnExt for Sp where
    Sp: Spawn + ?Sized,

fn spawn<Fut>(&self, future: Fut) -> Result<(), SpawnError> where
    Fut: Future<Output = ()> + Send + 'static,

Spawns a task that polls the given future with output () to completion. Read more

fn spawn_with_handle<Fut>(
    &self, 
    future: Fut
) -> Result<RemoteHandle<<Fut as Future>::Output>, SpawnError> where
    Fut: Future + Send + 'static,
    <Fut as Future>::Output: Send,

Spawns a task that polls the given future to completion and returns a future that resolves to the spawned future’s output. Read more

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

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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

[src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

[src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T[src]

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

[src]

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

fn with_current_subscriber(self) -> WithDispatch<Self>[src]

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