poll_fn.rs.html -- source

Files

base64

read

decoder.rs mod.rs

write

encoder.rs mod.rs

chunked_encoder.rs decode.rs display.rs encode.rs lib.rs tables.rs

bitflags

bytes

buf

ext

chain.rs limit.rs mod.rs reader.rs take.rs writer.rs

buf_impl.rs buf_mut.rs iter.rs mod.rs vec_deque.rs

fmt

debug.rs hex.rs mod.rs

bytes.rs bytes_mut.rs lib.rs loom.rs

cfg_if

dtoa

diyfp.rs dtoa.rs lib.rs

encoding_rs

ascii.rs big5.rs data.rs euc_jp.rs euc_kr.rs gb18030.rs handles.rs iso_2022_jp.rs lib.rs macros.rs mem.rs replacement.rs shift_jis.rs single_byte.rs utf_16.rs utf_8.rs variant.rs x_user_defined.rs

fnv

foreign_types

foreign_types_shared

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

fns.rs lib.rs never.rs

goauth

auth.rs credentials.rs lib.rs scopes.rs

h2

hashbrown

external_trait_impls

raw

bitmask.rs mod.rs sse2.rs

lib.rs macros.rs map.rs scopeguard.rs set.rs

http

header

map.rs mod.rs name.rs value.rs

uri

authority.rs builder.rs mod.rs path.rs port.rs scheme.rs

byte_str.rs convert.rs error.rs extensions.rs lib.rs method.rs request.rs response.rs status.rs version.rs

http_body

lib.rs next.rs size_hint.rs

httparse

simd

avx2.rs mod.rs sse42.rs

iter.rs lib.rs macros.rs

hyper

body

aggregate.rs body.rs mod.rs to_bytes.rs

client

connect

dns.rs http.rs mod.rs

conn.rs dispatch.rs mod.rs pool.rs service.rs

common

io

mod.rs rewind.rs

buf.rs drain.rs exec.rs lazy.rs mod.rs never.rs sync_wrapper.rs task.rs watch.rs

proto

h1

conn.rs date.rs decode.rs dispatch.rs encode.rs io.rs mod.rs role.rs

h2

client.rs mod.rs ping.rs server.rs

server

accept.rs conn.rs mod.rs shutdown.rs tcp.rs

service

http.rs make.rs mod.rs oneshot.rs util.rs

error.rs headers.rs lib.rs rt.rs upgrade.rs

hyper_tls

client.rs lib.rs stream.rs

idna

lib.rs punycode.rs uts46.rs

indexmap

map

core

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

iovec

sys

itoa

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

matches

memchr

x86

avx.rs mod.rs sse2.rs

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

mime

lib.rs parse.rs

mime_guess

impl_bin_search.rs lib.rs

mio

native_tls

imp

net2

sys

unix

impls.rs mod.rs

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

num_cpus

lib.rs linux.rs

once_cell

imp_std.rs lib.rs

openssl

openssl_probe

openssl_sys

percent_encoding

pin_project

pin_project_internal

pin_project

attribute.rs derive.rs mod.rs

lib.rs pinned_drop.rs project.rs utils.rs

pin_project_lite

pin_utils

lib.rs projection.rs stack_pin.rs

proc_macro2

detection.rs fallback.rs lib.rs parse.rs wrapper.rs

proc_macro_hack

error.rs iter.rs lib.rs parse.rs quote.rs

proc_macro_nested

quote

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

reqwest

ryu

buffer

pretty

exponent.rs mantissa.rs mod.rs

common.rs d2s.rs d2s_full_table.rs d2s_intrinsics.rs digit_table.rs f2s.rs f2s_intrinsics.rs lib.rs

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

fmt.rs 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

serde_json

features_check

io

value

de.rs from.rs index.rs mod.rs partial_eq.rs ser.rs

de.rs error.rs iter.rs lib.rs macros.rs map.rs number.rs read.rs ser.rs

serde_urlencoded

ser

key.rs mod.rs pair.rs part.rs value.rs

simpl

slab

smpl_jwt

socket2

sys

lib.rs sockaddr.rs socket.rs utils.rs

standback

syn

time

time_macros

time_macros_impl

time_crate

date.rs ext.rs lib.rs offset.rs time.rs

tinyvec

array.rs arrayvec.rs lib.rs tinyvec.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 loom.rs mod.rs pin.rs ready.rs scoped_tls.rs support.rs thread_local.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_tls

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

tower_service

tracing

dispatcher.rs field.rs level_filters.rs lib.rs macros.rs span.rs stdlib.rs subscriber.rs

tracing_core

callsite.rs dispatcher.rs event.rs field.rs lib.rs metadata.rs parent.rs span.rs stdlib.rs subscriber.rs

try_lock

unicase

unicode

ascii.rs lib.rs

unicode_bidi

char_data

mod.rs tables.rs

deprecated.rs explicit.rs format_chars.rs implicit.rs level.rs lib.rs prepare.rs

unicode_normalization

__test_api.rs decompose.rs lib.rs lookups.rs no_std_prelude.rs normalize.rs perfect_hash.rs quick_check.rs recompose.rs stream_safe.rs tables.rs

unicode_xid

lib.rs tables.rs

url

form_urlencoded.rs host.rs lib.rs origin.rs parser.rs path_segments.rs query_encoding.rs quirks.rs slicing.rs

want

//! 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