Struct libp2p::swarm::ExpandedSwarm[−][src]

pub struct ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    THandler: IntoProtocolsHandler,  { /* fields omitted */ }
Expand description

Contains the state of the network, plus the way it should behave.

Implementations

impl<TBehaviour, TInEvent, TOutEvent, THandler, THandleErr> ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>,
    TInEvent: Send + 'static,
    TOutEvent: Send + 'static,
    THandler: IntoProtocolsHandler + Send + 'static,
    THandleErr: Error + Send + 'static,
    <THandler as IntoProtocolsHandler>::Handler: ProtocolsHandler,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent == TInEvent,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent == TOutEvent,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::Error == THandleErr, [src]

pub fn new(
    transport: Boxed<(PeerId, StreamMuxerBox)>,
    behaviour: TBehaviour,
    local_peer_id: PeerId
) -> ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>[src]

Builds a new Swarm.

pub fn network_info(&self) -> NetworkInfo[src]

Returns information about the Network underlying the Swarm.

pub fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<Error>>[src]

Starts listening on the given address.

Returns an error if the address is not supported.

pub fn remove_listener(&mut self, id: ListenerId) -> Result<(), ()>[src]

Remove some listener.

Returns Ok(()) if there was a listener with this ID.

pub fn dial_addr(&mut self, addr: Multiaddr) -> Result<(), DialError>[src]

Initiates a new dialing attempt to the given address.

pub fn dial(&mut self, peer_id: &PeerId) -> Result<(), DialError>[src]

Initiates a new dialing attempt to the given peer.

pub fn listeners(&self) -> impl Iterator<Item = &Multiaddr>[src]

Returns an iterator that produces the list of addresses we’re listening on.

pub fn local_peer_id(&self) -> &PeerId[src]

Returns the peer ID of the swarm passed as parameter.

pub fn external_addresses(&self) -> impl Iterator<Item = &AddressRecord>[src]

Returns an iterator for AddressRecords of external addresses of the local node, in decreasing order of their current score.

pub fn add_external_address(
    &mut self,
    a: Multiaddr,
    s: AddressScore
) -> AddAddressResult[src]

Adds an external address record for the local node.

An external address is an address of the local node known to be (likely) reachable for other nodes, possibly taking into account NAT. The external addresses of the local node may be shared with other nodes by the NetworkBehaviour.

The associated score determines both the position of the address in the list of external addresses (which can determine the order in which addresses are used to connect to) as well as how long the address is retained in the list, depending on how frequently it is reported by the NetworkBehaviour via NetworkBehaviourAction::ReportObservedAddr or explicitly through this method.

pub fn remove_external_address(&mut self, addr: &Multiaddr) -> bool[src]

Removes an external address of the local node, regardless of its current score. See ExpandedSwarm::add_external_address for details.

Returns true if the address existed and was removed, false otherwise.

pub fn ban_peer_id(&mut self, peer_id: PeerId)[src]

Bans a peer by its peer ID.

Any incoming connection and any dialing attempt will immediately be rejected. This function has no effect if the peer is already banned.

pub fn unban_peer_id(&mut self, peer_id: PeerId)[src]

Unbans a peer.

pub fn is_connected(&self, peer_id: &PeerId) -> bool[src]

Checks whether the Network has an established connection to a peer.

pub fn behaviour(&self) -> &TBehaviour[src]

Returns a reference to the provided NetworkBehaviour.

pub fn behaviour_mut(&mut self) -> &mut TBehaviour[src]

Returns a mutable reference to the provided NetworkBehaviour.

pub async fn next_event(
    &'_ mut self
) -> SwarmEvent<<TBehaviour as NetworkBehaviour>::OutEvent, THandleErr>[src]

Returns the next event that happens in the Swarm.

Includes events from the NetworkBehaviour but also events about the connections status.

pub async fn next(&'_ mut self) -> <TBehaviour as NetworkBehaviour>::OutEvent[src]

Returns the next event produced by the NetworkBehaviour.

Trait Implementations

impl<TBehaviour, TInEvent, TOutEvent, THandler> FusedStream for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>,
    TInEvent: Send + 'static,
    TOutEvent: Send + 'static,
    THandler: IntoProtocolsHandler + Send + 'static,
    <THandler as IntoProtocolsHandler>::Handler: ProtocolsHandler,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent == TInEvent,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent == TOutEvent, [src]

the stream of behaviour events never terminates, so we can implement fused for it

pub fn is_terminated(&self) -> bool[src]

Returns true if the stream should no longer be polled.

impl<TBehaviour, TInEvent, TOutEvent, THandler> Stream for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    TBehaviour: NetworkBehaviour<ProtocolsHandler = THandler>,
    TInEvent: Send + 'static,
    TOutEvent: Send + 'static,
    THandler: IntoProtocolsHandler + Send + 'static,
    <THandler as IntoProtocolsHandler>::Handler: ProtocolsHandler,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent == TInEvent,
    <<THandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent == TOutEvent, [src]

type Item = <TBehaviour as NetworkBehaviour>::OutEvent

Values yielded by the stream.

pub fn poll_next(
    self: Pin<&mut ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>>,
    cx: &mut Context<'_>
) -> Poll<Option<<ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> as Stream>::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

impl<TBehaviour, TInEvent, TOutEvent, THandler> Unpin for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    THandler: IntoProtocolsHandler, [src]

Auto Trait Implementations

impl<TBehaviour, TInEvent, TOutEvent, THandler> !RefUnwindSafe for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

impl<TBehaviour, TInEvent, TOutEvent, THandler> Send for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler> where
    TBehaviour: Send,
    TInEvent: Send,
    TOutEvent: Send, 

impl<TBehaviour, TInEvent, TOutEvent, THandler> !Sync for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

impl<TBehaviour, TInEvent, TOutEvent, THandler> !UnwindSafe for ExpandedSwarm<TBehaviour, TInEvent, TOutEvent, THandler>

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

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

Performs the conversion.

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<T> StreamExt for T where
    T: Stream + ?Sized, 

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

Advances the stream and returns the next value. Read more

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

Creates a stream that yields its first n elements. Read more

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates a stream that yields elements based on a predicate. Read more

fn step_by(self, step: usize) -> StepBy<Self>

Creates a stream that yields each stepth element. Read more

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

Takes two streams and creates a new stream over both in sequence. Read more

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Stream<Item = &'a T>,
    T: Clone + 'a, 

Creates an stream which copies all of its elements. Read more

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Stream<Item = &'a T>,
    T: Copy + 'a, 

Creates an stream which copies all of its elements. Read more

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

Creates a stream that yields the provided values infinitely and in order. Read more

fn enumerate(self) -> Enumerate<Self>

Creates a stream that gives the current element’s count as well as the next value. Read more

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

Takes a closure and creates a stream that calls that closure on every element of this stream. Read more

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

A combinator that does something with each element in the stream, passing the value on. Read more

fn last(self) -> LastFuture<Self, Self::Item>

Returns the last element of the stream. Read more

fn fuse(self) -> Fuse<Self>

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

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Creates a stream that uses a predicate to determine if an element should be yielded. Read more

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Both filters and maps a stream. Read more

fn min_by_key<B, F>(self, key_by: F) -> MinByKeyFuture<Self, Self::Item, F> where
    F: FnMut(&Self::Item) -> B,
    B: Ord, 

Returns the element that gives the minimum value with respect to the specified key function. If several elements are equally minimum, the first element is returned. If the stream is empty, None is returned. Read more

fn max_by_key<B, F>(self, key_by: F) -> MaxByKeyFuture<Self, Self::Item, F> where
    F: FnMut(&Self::Item) -> B,
    B: Ord, 

Returns the element that gives the maximum value with respect to the specified key function. If several elements are equally maximum, the first element is returned. If the stream is empty, None is returned. Read more

fn min_by<F>(self, compare: F) -> MinByFuture<Self, F, Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the minimum value with respect to the specified comparison function. If several elements are equally minimum, the first element is returned. If the stream is empty, None is returned. Read more

fn max(self) -> MaxFuture<Self, Self::Item> where
    Self::Item: Ord, 

Returns the element that gives the maximum value. If several elements are equally maximum, the first element is returned. If the stream is empty, None is returned. Read more

fn min(self) -> MinFuture<Self, Self::Item> where
    Self::Item: Ord, 

Returns the element that gives the minimum value. If several elements are equally minimum, the first element is returned. If the stream is empty, None is returned. Read more

fn max_by<F>(self, compare: F) -> MaxByFuture<Self, F, Self::Item> where
    F: FnMut(&Self::Item, &Self::Item) -> Ordering, 

Returns the element that gives the maximum value with respect to the specified comparison function. If several elements are equally maximum, the first element is returned. If the stream is empty, None is returned. Read more

fn nth(&mut self, n: usize) -> NthFuture<'_, Self> where
    Self: Unpin, 

Returns the nth element of the stream. Read more

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

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

fn find<P>(&mut self, p: P) -> FindFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(&Self::Item) -> bool, 

Searches for an element in a stream that satisfies a predicate. Read more

fn find_map<F, B>(&mut self, f: F) -> FindMapFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> Option<B>, 

Applies function to the elements of stream and returns the first non-none result. Read more

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

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

fn for_each<F>(self, f: F) -> ForEachFuture<Self, F> where
    F: FnMut(Self::Item), 

Call a closure on each element of the stream. Read more

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

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

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

A stream adaptor similar to fold that holds internal state and produces a new stream. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Combinator that skips elements based on a predicate. Read more

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

Creates a combinator that skips the first n elements. Read more

fn try_fold<B, F, T, E>(
    &mut self,
    init: T,
    f: F
) -> TryFoldFuture<'_, Self, F, T> where
    Self: Unpin,
    F: FnMut(B, Self::Item) -> Result<T, E>, 

A combinator that applies a function as long as it returns successfully, producing a single, final value. Immediately returns the error when the function returns unsuccessfully. Read more

fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> Result<(), E>, 

Applies a falliable function to each element in a stream, stopping at first error and returning it. Read more

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

‘Zips up’ two streams into a single stream of pairs. Read more

fn partial_cmp<S>(self, other: S) -> PartialCmpFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialOrd<<S as Stream>::Item>, 

Lexicographically compares the elements of this Stream with those of another. Read more

fn position<P>(&mut self, predicate: P) -> PositionFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(Self::Item) -> bool, 

Searches for an element in a Stream that satisfies a predicate, returning its index. Read more

fn cmp<S>(self, other: S) -> CmpFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: Ord, 

Lexicographically compares the elements of this Stream with those of another using ‘Ord’. Read more

fn ne<S>(self, other: S) -> NeFuture<Self, S> where
    S: Stream,
    Self::Item: PartialEq<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically not equal to those of another. Read more

fn ge<S>(self, other: S) -> GeFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialOrd<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically greater than or equal to those of another. Read more

fn eq<S>(self, other: S) -> EqFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialEq<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically equal to those of another. Read more

fn gt<S>(self, other: S) -> GtFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialOrd<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically greater than those of another. Read more

fn le<S>(self, other: S) -> LeFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialOrd<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically less or equal to those of another. Read more

fn lt<S>(self, other: S) -> LtFuture<Self, S> where
    Self: Stream,
    S: Stream,
    Self::Item: PartialOrd<<S as Stream>::Item>, 

Determines if the elements of this Stream are lexicographically less than those of another. Read more

impl<S> StreamExt for S where
    S: Stream + ?Sized, 

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

A convenience for calling [Stream::poll_next()] on !Unpin types.

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

Retrieves the next item in the stream. Read more

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

Retrieves the next item in the stream. Read more

fn count(self) -> CountFuture<Self>

Counts the number of items in the stream. Read more

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

Maps items of the stream to new values using a closure. Read more

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

Maps items to streams and then concatenates them. Read more

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

Concatenates inner streams. Read more

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

Maps items of the stream to new values using an async closure. Read more

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Keeps items of the stream for which predicate returns true. Read more

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

Filters and maps items of the stream using a closure. Read more

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

Takes only the first n items of the stream. Read more

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Takes items while predicate returns true. Read more

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

Skips the first n items of the stream. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool, 

Skips items while predicate returns true. Read more

fn step_by(self, step: usize) -> StepBy<Self>

Yields every stepth item. Read more

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

Appends another stream to the end of this one. Read more

fn cloned<'a, T>(self) -> Cloned<Self> where
    Self: Stream<Item = &'a T>,
    T: Clone + 'a, 

Clones all items. Read more

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Stream<Item = &'a T>,
    T: Copy + 'a, 

Copies all items. Read more

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

Collects all items in the stream into a collection. Read more

fn try_collect<T, E, C>(self) -> TryCollectFuture<Self, C> where
    Self: Stream<Item = Result<T, E>>,
    C: Default + Extend<T>, 

Collects all items in the fallible stream into a collection. Read more

fn partition<B, P>(self, predicate: P) -> PartitionFuture<Self, P, B> where
    P: FnMut(&Self::Item) -> bool,
    B: Default + Extend<Self::Item>, 

Partitions items into those for which predicate is true and those for which it is false, and then collects them into two collections. Read more

fn fold<T, F>(self, init: T, f: F) -> FoldFuture<Self, F, T> where
    F: FnMut(T, Self::Item) -> T, 

Accumulates a computation over the stream. Read more

fn try_fold<T, E, F, B>(
    &mut self,
    init: B,
    f: F
) -> TryFoldFuture<'_, Self, F, B> where
    Self: Stream<Item = Result<T, E>> + Unpin,
    F: FnMut(B, T) -> Result<B, E>, 

Accumulates a fallible computation over the stream. Read more

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 

Maps items of the stream to new values using a state value and a closure. Read more

fn fuse(self) -> Fuse<Self>

Fuses the stream so that it stops yielding items after the first None. Read more

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

Repeats the stream from beginning to end, forever. Read more

fn enumerate(self) -> Enumerate<Self>

Enumerates items, mapping them to (index, item). Read more

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

Calls a closure on each item and passes it on. Read more

fn nth(&mut self, n: usize) -> NthFuture<'_, Self> where
    Self: Unpin, 

Gets the nth item of the stream. Read more

fn last(self) -> LastFuture<Self>

Returns the last item in the stream. Read more

fn find<P>(&mut self, predicate: P) -> FindFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(&Self::Item) -> bool, 

Finds the first item of the stream for which predicate returns true. Read more

fn find_map<F, B>(&mut self, f: F) -> FindMapFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> Option<B>, 

Applies a closure to items in the stream and returns the first Some result. Read more

fn position<P>(&mut self, predicate: P) -> PositionFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(Self::Item) -> bool, 

Finds the index of the first item of the stream for which predicate returns true. Read more

fn all<P>(&mut self, predicate: P) -> AllFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(Self::Item) -> bool, 

Tests if predicate returns true for all items in the stream. Read more

fn any<P>(&mut self, predicate: P) -> AnyFuture<'_, Self, P> where
    Self: Unpin,
    P: FnMut(Self::Item) -> bool, 

Tests if predicate returns true for any item in the stream. Read more

fn for_each<F>(self, f: F) -> ForEachFuture<Self, F> where
    F: FnMut(Self::Item), 

Calls a closure on each item of the stream. Read more

fn try_for_each<F, E>(&mut self, f: F) -> TryForEachFuture<'_, Self, F> where
    Self: Unpin,
    F: FnMut(Self::Item) -> Result<(), E>, 

Calls a fallible closure on each item of the stream, stopping on first error. Read more

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

Zips up two streams into a single stream of pairs. Read more

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

Collects a stream of pairs into a pair of collections. Read more

fn or<S>(self, other: S) -> Or<Self, S> where
    S: Stream<Item = Self::Item>, 

Merges with other stream, preferring items from self whenever both streams are ready. Read more

fn race<S>(self, other: S) -> Race<Self, S> where
    S: Stream<Item = Self::Item>, 

Merges with other stream, with no preference for either stream when both are ready. Read more

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

Boxes the stream and changes its type to dyn Stream + Send + 'a. Read more

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

Boxes the stream and changes its type to dyn Stream + 'a. 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<S> TryStreamExt for S where
    S: TryStream, [src]

fn timeout(self, dur: Duration) -> TimeoutStream<Self> where
    Self::Error: From<Error>, [src]

Creates a new stream which will take at most dur time to yield each item of the stream. Read more

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

pub fn vzip(self) -> V