Skip to content

Hide async_gen_internals from standard library documentation #123528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 6, 2024
Merged

Hide async_gen_internals from standard library documentation #123528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions library/core/src/async_iter/async_iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ where
impl<T> Poll<Option<T>> {
/// A helper function for internal desugaring -- produces `Ready(Some(t))`,
/// which corresponds to the async iterator yielding a value.
#[doc(hidden)]
#[unstable(feature = "async_gen_internals", issue = "none")]
#[lang = "AsyncGenReady"]
pub fn async_gen_ready(t: T) -> Self {
Expand All @@ -124,13 +125,15 @@ impl<T> Poll<Option<T>> {

/// A helper constant for internal desugaring -- produces `Pending`,
/// which corresponds to the async iterator pending on an `.await`.
#[doc(hidden)]
#[unstable(feature = "async_gen_internals", issue = "none")]
#[lang = "AsyncGenPending"]
// FIXME(gen_blocks): This probably could be deduplicated.
pub const PENDING: Self = Poll::Pending;

/// A helper constant for internal desugaring -- produces `Ready(None)`,
/// which corresponds to the async iterator finishing its iteration.
#[doc(hidden)]
#[unstable(feature = "async_gen_internals", issue = "none")]
#[lang = "AsyncGenFinished"]
pub const FINISHED: Self = Poll::Ready(None);
Expand Down