poll_fn.rs.html -- source

Files

abomonation

abomonated.rs lib.rs

abomonation_derive

ansi_term

ansi.rs debug.rs difference.rs display.rs lib.rs style.rs windows.rs write.rs

async_trait

args.rs expand.rs lib.rs lifetime.rs parse.rs receiver.rs

atty

bincode

de

ser

config.rs error.rs internal.rs lib.rs

bitflags

byteorder

bytes

buf

buf.rs buf_mut.rs chain.rs from_buf.rs into_buf.rs iter.rs mod.rs reader.rs take.rs vec_deque.rs writer.rs

bytes.rs debug.rs lib.rs

cfg_if

chrono

format

mod.rs parse.rs parsed.rs scan.rs strftime.rs

naive

date.rs datetime.rs internals.rs isoweek.rs time.rs

offset

fixed.rs local.rs mod.rs utc.rs

date.rs datetime.rs div.rs lib.rs round.rs

clap

dirs

dirs_sys

lib.rs xdg_user_dirs.rs

erdos

fixedbitset

lib.rs range.rs

fnv

futures

futures_channel

mpsc

mod.rs queue.rs sink_impl.rs

lib.rs lock.rs oneshot.rs

futures_core

task

__internal

atomic_waker.rs mod.rs

future.rs lib.rs stream.rs

futures_executor

enter.rs lib.rs local_pool.rs

futures_io

futures_macro

join.rs lib.rs select.rs

futures_sink

futures_task

arc_wake.rs future_obj.rs lib.rs noop_waker.rs spawn.rs waker.rs waker_ref.rs

futures_util

async_await

join_mod.rs mod.rs pending.rs poll.rs random.rs select_mod.rs

future

io

lock

bilock.rs mod.rs mutex.rs

sink

buffer.rs close.rs drain.rs err_into.rs fanout.rs flush.rs map_err.rs mod.rs send.rs send_all.rs with.rs with_flat_map.rs

stream

task

mod.rs spawn.rs

lib.rs never.rs

indexmap

equivalent.rs lib.rs macros.rs map.rs mutable_keys.rs set.rs util.rs

iovec

sys

lazy_static

inline_lazy.rs lib.rs

libc

unix

linux_like

linux

gnu

b64

x86_64

align.rs mod.rs not_x32.rs

align.rs mod.rs

align.rs mod.rs

align.rs mod.rs

fixed_width_ints.rs lib.rs macros.rs

log

lib.rs macros.rs

memchr

x86

avx.rs mod.rs sse2.rs

fallback.rs iter.rs lib.rs naive.rs

mio

net2

sys

unix

impls.rs mod.rs

ext.rs lib.rs socket.rs tcp.rs udp.rs unix.rs utils.rs

num_cpus

num_integer

lib.rs roots.rs

num_traits

ops

checked.rs inv.rs mod.rs mul_add.rs saturating.rs wrapping.rs

bounds.rs cast.rs float.rs identities.rs int.rs lib.rs macros.rs pow.rs real.rs sign.rs

petgraph

pin_project_lite

pin_utils

lib.rs projection.rs stack_pin.rs

proc_macro2

fallback.rs lib.rs strnom.rs wrapper.rs

proc_macro_hack

proc_macro_nested

quote

ext.rs format.rs ident_fragment.rs lib.rs runtime.rs spanned.rs to_tokens.rs

rand

rand_chacha

chacha.rs lib.rs

rand_core

rand_hc

hc128.rs lib.rs

rand_isaac

isaac.rs isaac64.rs isaac_array.rs lib.rs

rand_jitter

dummy_log.rs error.rs lib.rs platform.rs

rand_os

dummy_log.rs lib.rs linux_android.rs random_device.rs

rand_pcg

lib.rs pcg128.rs pcg64.rs

rand_xorshift

serde

de

from_primitive.rs ignored_any.rs impls.rs mod.rs utf8.rs value.rs

private

de.rs macros.rs mod.rs ser.rs

ser

impls.rs impossible.rs mod.rs

export.rs integer128.rs lib.rs macros.rs

serde_derive

internals

ast.rs attr.rs case.rs check.rs ctxt.rs mod.rs symbol.rs

bound.rs de.rs dummy.rs fragment.rs lib.rs pretend.rs ser.rs try.rs

sha1

slab

slog

key

mod.rs static.rs

slog_term

strsim

syn

synstructure

lib.rs macros.rs

term

terminfo

parser

compiled.rs names.rs

mod.rs parm.rs searcher.rs

textwrap

indentation.rs lib.rs splitting.rs

thread_local

cached.rs lib.rs thread_id.rs unreachable.rs

time

display.rs duration.rs lib.rs parse.rs sys.rs

tokio

future

maybe_done.rs mod.rs poll_fn.rs ready.rs try_join.rs

io

loom

std

atomic_ptr.rs atomic_u16.rs atomic_u32.rs atomic_u64.rs atomic_u8.rs atomic_usize.rs mod.rs unsafe_cell.rs

macros

cfg.rs join.rs loom.rs mod.rs pin.rs ready.rs scoped_tls.rs select.rs support.rs thread_local.rs try_join.rs

net

tcp

incoming.rs listener.rs mod.rs split.rs split_owned.rs stream.rs

park

either.rs mod.rs thread.rs

runtime

stream

all.rs any.rs chain.rs collect.rs empty.rs filter.rs filter_map.rs fold.rs fuse.rs iter.rs map.rs merge.rs mod.rs next.rs once.rs pending.rs skip.rs skip_while.rs stream_map.rs take.rs take_while.rs timeout.rs try_next.rs

sync

task

blocking.rs mod.rs spawn.rs yield_now.rs

time

driver

atomic_stack.rs entry.rs handle.rs mod.rs registration.rs stack.rs

wheel

level.rs mod.rs stack.rs

clock.rs delay.rs delay_queue.rs error.rs instant.rs interval.rs mod.rs throttle.rs timeout.rs

util

slab

addr.rs entry.rs generation.rs mod.rs page.rs shard.rs slot.rs stack.rs

bit.rs intrusive_double_linked_list.rs linked_list.rs mod.rs rand.rs try_lock.rs wake.rs

coop.rs lib.rs prelude.rs

tokio_macros

entry.rs lib.rs select.rs

tokio_serde

buffer_one.rs lib.rs

tokio_serde_bincode

tokio_util

codec

bytes_codec.rs decoder.rs encoder.rs framed.rs framed_read.rs framed_write.rs length_delimited.rs lines_codec.rs mod.rs

unicode_width

lib.rs tables.rs

unicode_xid

lib.rs tables.rs

uuid

adapter

core_support

compact.rs mod.rs

parser

core_support.rs mod.rs std_support.rs

builder.rs core_support.rs lib.rs prelude.rs serde_support.rs std_support.rs v4.rs v5.rs

vec_map

//! Definition of the `PollFn` combinator

use core::fmt;
use core::pin::Pin;
use futures_core::stream::Stream;
use futures_core::task::{Context, Poll};

/// Stream for the [`poll_fn`] function.
#[must_use = "streams do nothing unless polled"]
pub struct PollFn<F> {
    f: F,
}

impl<F> Unpin for PollFn<F> {}

impl<F> fmt::Debug for PollFn<F> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("PollFn").finish()
    }
}

/// Creates a new stream wrapping a function returning `Poll<Option<T>>`.
///
/// Polling the returned stream calls the wrapped function.
///
/// # Examples
///
/// ```
/// use futures::stream::poll_fn;
/// use futures::task::Poll;
///
/// let mut counter = 1usize;
///
/// let read_stream = poll_fn(move |_| -> Poll<Option<String>> {
///     if counter == 0 { return Poll::Ready(None); }
///     counter -= 1;
///     Poll::Ready(Some("Hello, World!".to_owned()))
/// });
/// ```
pub fn poll_fn<T, F>(f: F) -> PollFn<F>
where
    F: FnMut(&mut Context<'_>) -> Poll<Option<T>>,
{
    PollFn { f }
}

impl<T, F> Stream for PollFn<F>
where
    F: FnMut(&mut Context<'_>) -> Poll<Option<T>>,
{
    type Item = T;

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<T>> {
        (&mut self.f)(cx)
    }
}

Keyboard Shortcuts

?: Show this help dialog
S: Focus the search field
↑: Move up in search results
↓: Move down in search results
↹: Switch tab
⏎: Go to active search result
+: Expand all sections
-: Collapse all sections

Search Tricks

Prefix searches with a type followed by a colon (e.g., fn:) to restrict the search to a given type.

Accepted types are: fn, mod, struct, enum, trait, type, macro, and const.

Search functions by type signature (e.g., vec -> usize or * -> vec)

Search multiple things at once by splitting your query with comma (e.g., str,u8 or String,struct:Vec,test)

You can look for items with an exact name by putting double quotes around your request: "string"

Look for items inside another one by searching for a path: vec::Vec