Struct rocket::response::stream::One[][src]

pub struct One<T: Unpin>(_);
Expand description

A stream that yields exactly one value.

A ReaderStream which wraps this type and yields one AsyncRead is returned by ReaderStream::one(). A One can also be constructed via One::from().

Example

use rocket::response::stream::One;
use rocket::futures::stream::StreamExt;

let mut stream = One::from("hello!");
let values: Vec<_> = stream.collect().await;
assert_eq!(values, ["hello!"]);

Trait Implementations

impl<T: Unpin> From<T> for One<T>[src]

Returns a One stream that will yield value exactly once.

Example

use rocket::response::stream::One;

let mut stream = One::from("hello!");

fn from(value: T) -> Self[src]

Performs the conversion.

impl<T: Unpin> Stream for One<T>[src]

type Item = T

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    _: &mut Context<'_>
) -> Poll<Option<Self::Item>>
[src]

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations

impl<T> RefUnwindSafe for One<T> where
    T: RefUnwindSafe

impl<T> Send for One<T> where
    T: Send

impl<T> Sync for One<T> where
    T: Sync

impl<T> Unpin for One<T>

impl<T> UnwindSafe for One<T> where
    T: UnwindSafe

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<!> for T[src]

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

Performs the conversion.

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, U> Into<U> for T where
    U: From<T>, 
[src]

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

Performs the conversion.

impl<T> IntoCollection<T> for T

pub fn into_collection<A>(self) -> SmallVec<A> where
    A: Array<Item = T>, 

Converts self into a collection.

pub fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
    F: FnMut(T) -> U,
    A: Array<Item = U>, 

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> StreamExt for T where
    T: Stream + ?Sized

fn next(&mut self) -> Next<'_, Self> where
    Self: Unpin

Creates a future that resolves to the next item in the stream. Read more

fn into_future(self) -> StreamFuture<Self> where
    Self: Unpin

Converts this stream into a future of (next_item, tail_of_stream). If the stream terminates, then the next item is None. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T, 

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

fn enumerate(self) -> Enumerate<Self>

Creates a stream which gives the current iteration count as well as the next value. Read more

fn filter<Fut, F>(self, f: F) -> Filter<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, 

Filters the values produced by this stream according to the provided asynchronous predicate. Read more

fn filter_map<Fut, T, F>(self, f: F) -> FilterMap<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = Option<T>>, 

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future

Computes from this stream’s items new items of a different type using an asynchronous closure. Read more

fn collect<C>(self) -> Collect<Self, C> where
    C: Default + Extend<Self::Item>, 

Transforms a stream into a collection, returning a future representing the result of that computation. Read more

fn unzip<A, B, FromA, FromB>(self) -> Unzip<Self, FromA, FromB> where
    Self: Stream<Item = (A, B)>,
    FromA: Default + Extend<A>,
    FromB: Default + Extend<B>, 

Converts a stream of pairs into a future, which resolves to pair of containers. Read more

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default

Concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

fn cycle(self) -> Cycle<Self> where
    Self: Clone

Repeats a stream endlessly. Read more

fn fold<T, Fut, F>(self, init: T, f: F) -> Fold<Self, Fut, T, F> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: Future<Output = T>, 

Execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream, 

Flattens a stream of streams into just one continuous stream. Read more

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: Stream, 

Maps a stream like [StreamExt::map] but flattens nested Streams. Read more

fn scan<S, B, Fut, F>(self, initial_state: S, f: F) -> Scan<Self, S, Fut, F> where
    F: FnMut(&mut S, Self::Item) -> Fut,
    Fut: Future<Output = Option<B>>, 

Combinator similar to [StreamExt::fold] that holds internal state and produces a new stream. Read more

fn skip_while<Fut, F>(self, f: F) -> SkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, 

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn take_while<Fut, F>(self, f: F) -> TakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Item) -> Fut,
    Fut: Future<Output = bool>, 

Take elements from this stream while the provided asynchronous predicate resolves to true. Read more

fn take_until<Fut>(self, fut: Fut) -> TakeUntil<Self, Fut> where
    Fut: Future

Take elements from this stream until the provided future resolves. Read more

fn for_each<Fut, F>(self, f: F) -> ForEach<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, 

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

fn for_each_concurrent<Fut, F>(
    self,
    limit: impl Into<Option<usize>>,
    f: F
) -> ForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Item) -> Fut,
    Fut: Future<Output = ()>, 

Runs this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available. Read more

fn take(self, n: usize) -> Take<Self>

Creates a new stream of at most n items of the underlying stream. Read more

fn skip(self, n: usize) -> Skip<Self>

Creates a new stream which skips n items of the underlying stream. Read more

fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll_next will never again be called once it has finished. This method can be used to turn any Stream into a FusedStream. Read more

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe

Catches unwinding panics while polling the stream. Read more

fn boxed<'a>(
    self
) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a + Send, Global>> where
    Self: Send + 'a, 

Wrap the stream in a Box, pinning it. Read more

fn boxed_local<'a>(self) -> Pin<Box<dyn Stream<Item = Self::Item> + 'a, Global>> where
    Self: 'a, 

Wrap the stream in a Box, pinning it. Read more

fn buffered(self, n: usize) -> Buffered<Self> where
    Self::Item: Future

An adaptor for creating a buffered list of pending futures. Read more

fn buffer_unordered(self, n: usize) -> BufferUnordered<Self> where
    Self::Item: Future

An adaptor for creating a buffered list of pending futures (unordered). Read more

fn zip<St>(self, other: St) -> Zip<Self, St> where
    St: Stream, 

An adapter for zipping two streams together. Read more

fn chain<St>(self, other: St) -> Chain<Self, St> where
    St: Stream<Item = Self::Item>, 

Adapter for chaining two streams. Read more

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method. Read more

fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector. Read more

fn ready_chunks(self, capacity: usize) -> ReadyChunks<Self>

An adaptor for chunking up ready items of the stream inside a vector. Read more

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    Self: TryStream,
    S: Sink<Self::Ok, Error = Self::Error>, 

A future that completes after the given stream has been fully processed into the sink and the sink has been flushed and closed. Read more

fn split<Item>(self) -> (SplitSink<Self, Item>, SplitStream<Self>) where
    Self: Sink<Item>, 

Splits this Stream + Sink object into separate Sink and Stream objects. Read more

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each item of this stream, afterwards passing it on. Read more

fn left_stream<B>(self) -> Either<Self, B> where
    B: Stream<Item = Self::Item>, 

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

fn right_stream<B>(self) -> Either<B, Self> where
    B: Stream<Item = Self::Item>, 

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

fn poll_next_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> where
    Self: Unpin

A convenience method for calling [Stream::poll_next] on Unpin stream types. Read more

fn select_next_some(&mut self) -> SelectNextSome<'_, Self> where
    Self: Unpin + FusedStream, 

Returns a Future that resolves when the next item in this stream is ready. Read more

impl<St> StreamExt for St where
    St: Stream + ?Sized
[src]

fn next(&mut self) -> Next<'_, Self> where
    Self: Unpin
[src]

Consumes and returns the next value in the stream or None if the stream is finished. Read more

fn try_next<T, E>(&mut self) -> TryNext<'_, Self> where
    Self: Stream<Item = Result<T, E>> + Unpin
[src]

Consumes and returns the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

fn map<T, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> T, 
[src]

Maps this stream’s items to a different type, returning a new stream of the resulting type. Read more

fn merge<U>(self, other: U) -> Merge<Self, U> where
    U: Stream<Item = Self::Item>, 
[src]

Combine two streams into one by interleaving the output of both as it is produced. Read more

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool
[src]

Filters the values produced by this stream according to the provided predicate. Read more

fn filter_map<T, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<T>, 
[src]

Filters the values produced by this stream while simultaneously mapping them to a different type according to the provided closure. Read more

fn fuse(self) -> Fuse<Self>[src]

Creates a stream which ends after the first None. Read more

fn take(self, n: usize) -> Take<Self>[src]

Creates a new stream of at most n items of the underlying stream. Read more

fn take_while<F>(self, f: F) -> TakeWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool
[src]

Take elements from this stream while the provided predicate resolves to true. Read more

fn skip(self, n: usize) -> Skip<Self>[src]

Creates a new stream that will skip the n first items of the underlying stream. Read more

fn skip_while<F>(self, f: F) -> SkipWhile<Self, F> where
    F: FnMut(&Self::Item) -> bool
[src]

Skip elements from the underlying stream while the provided predicate resolves to true. Read more

fn all<F>(&mut self, f: F) -> AllFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> bool
[src]

Tests if every element of the stream matches a predicate. Read more

fn any<F>(&mut self, f: F) -> AnyFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> bool
[src]

Tests if any element of the stream matches a predicate. Read more

fn chain<U>(self, other: U) -> Chain<Self, U> where
    U: Stream<Item = Self::Item>, 
[src]

Combine two streams into one by first returning all values from the first stream then all values from the second stream. Read more

fn fold<B, F>(self, init: B, f: F) -> FoldFuture<Self, B, F> where
    F: FnMut(B, Self::Item) -> B, 
[src]

A combinator that applies a function to every element in a stream producing a single, final value. Read more

fn collect<T>(self) -> Collect<Self, T> where
    T: FromStream<Self::Item>, 
[src]

Drain stream pushing all emitted values into a collection. Read more

fn timeout(self, duration: Duration) -> Timeout<Self>[src]

Applies a per-item timeout to the passed stream. Read more

fn throttle(self, duration: Duration) -> Throttle<Self>[src]

Slows down a stream by enforcing a delay between items. 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<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

pub fn try_poll_next(
    self: Pin<&mut S>,
    cx: &mut Context<'_>
) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized

fn err_into<E>(self) -> ErrInto<Self, E> where
    Self::Error: Into<E>, 

Wraps the current stream in a new stream which converts the error type into the one provided. Read more

fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where
    F: FnMut(Self::Ok) -> T, 

Wraps the current stream in a new stream which maps the success value using the provided closure. Read more

fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> E, 

Wraps the current stream in a new stream which maps the error value using the provided closure. Read more

fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Error = Self::Error>, 

Chain on a computation for when a value is ready, passing the successful results to the provided closure f. Read more

fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where
    F: FnMut(Self::Error) -> Fut,
    Fut: TryFuture<Ok = Self::Ok>, 

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f. Read more

fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where
    F: FnMut(&Self::Ok), 

Do something with the success value of this stream, afterwards passing it on. Read more

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 

Do something with the error value of this stream, afterwards passing it on. Read more

fn into_stream(self) -> IntoStream<Self>

Wraps a [TryStream] into a type that implements Stream Read more

fn try_next(&mut self) -> TryNext<'_, Self> where
    Self: Unpin

Creates a future that attempts to resolve the next item in the stream. If an error is encountered before the next item, the error is returned instead. Read more

fn try_for_each<Fut, F>(self, f: F) -> TryForEach<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = (), Error = Self::Error>, 

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream. Read more

fn try_skip_while<Fut, F>(self, f: F) -> TrySkipWhile<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: TryFuture<Ok = bool, Error = Self::Error>, 

Skip elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn try_take_while<Fut, F>(self, f: F) -> TryTakeWhile<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: TryFuture<Ok = bool, Error = Self::Error>, 

Take elements on this stream while the provided asynchronous predicate resolves to true. Read more

fn try_for_each_concurrent<Fut, F>(
    self,
    limit: impl Into<Option<usize>>,
    f: F
) -> TryForEachConcurrent<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: Future<Output = Result<(), Self::Error>>, 

Attempts to run this stream to completion, executing the provided asynchronous closure for each element on the stream concurrently as elements become available, exiting as soon as an error occurs. Read more

fn try_collect<C>(self) -> TryCollect<Self, C> where
    C: Default + Extend<Self::Ok>, 

Attempt to transform a stream into a collection, returning a future representing the result of that computation. Read more

fn try_filter<Fut, F>(self, f: F) -> TryFilter<Self, Fut, F> where
    F: FnMut(&Self::Ok) -> Fut,
    Fut: Future<Output = bool>, 

Attempt to filter the values produced by this stream according to the provided asynchronous closure. Read more

fn try_filter_map<Fut, F, T>(self, f: F) -> TryFilterMap<Self, Fut, F> where
    F: FnMut(Self::Ok) -> Fut,
    Fut: TryFuture<Ok = Option<T>, Error = Self::Error>, 

Attempt to filter the values produced by this stream while simultaneously mapping them to a different type according to the provided asynchronous closure. Read more

fn try_flatten(self) -> TryFlatten<Self> where
    Self::Ok: TryStream,
    <Self::Ok as TryStream>::Error: From<Self::Error>, 

Flattens a stream of streams into just one continuous stream. Read more

fn try_fold<T, Fut, F>(self, init: T, f: F) -> TryFold<Self, Fut, T, F> where
    F: FnMut(T, Self::Ok) -> Fut,
    Fut: TryFuture<Ok = T, Error = Self::Error>, 

Attempt to execute an accumulating asynchronous computation over a stream, collecting all the values into one final result. Read more

fn try_concat(self) -> TryConcat<Self> where
    Self::Ok: Extend<<Self::Ok as IntoIterator>::Item>,
    Self::Ok: IntoIterator,
    Self::Ok: Default

Attempt to concatenate all items of a stream into a single extendable destination, returning a future representing the end result. Read more

fn try_buffer_unordered(self, n: usize) -> TryBufferUnordered<Self> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error, 

Attempt to execute several futures from a stream concurrently (unordered). Read more

fn try_buffered(self, n: usize) -> TryBuffered<Self> where
    Self::Ok: TryFuture,
    <Self::Ok as TryFuture>::Error == Self::Error, 

Attempt to execute several futures from a stream concurrently. Read more

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

A convenience method for calling [TryStream::try_poll_next] on Unpin stream types. Read more

fn into_async_read(self) -> IntoAsyncRead<Self> where
    Self: TryStreamExt<Error = Error> + Unpin,
    Self::Ok: AsRef<[u8]>, 

Adapter that converts this stream into an AsyncRead. Read more

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

pub fn vzip(self) -> V