Skip to content

Make Coroutine::with_stack_unchecked public #74

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
Amanieu merged 1 commit into from
Mar 29, 2026
Merged

Make Coroutine::with_stack_unchecked public #74

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
9 changes: 8 additions & 1 deletion src/coroutine.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,14 @@ impl<Input, Yield, Return, Stack: stack::Stack> Coroutine<Input, Yield, Return,

/// Unsafe version of [`Coroutine::with_stack`] without `'static` bounds.
/// This is used by `ScopedCoroutine`.
pub(crate) unsafe fn with_stack_unchecked<F>(stack: Stack, func: F) -> Self
///
/// # Safety
/// The caller must ensure that all the data borrowed by `func` remains valid
/// from the moment the coroutine is created and until it is either driven to completion or dropped.
///
/// If the coroutine is forgotten (with [`std::mem::forget`]), the stack memory cannot be reclaimed and reused,
/// and the data borrowed by `func` must remain valid indefinitely.
pub unsafe fn with_stack_unchecked<F>(stack: Stack, func: F) -> Self
where
F: FnOnce(&Yielder<Input, Yield>, Input) -> Return,
{
Expand Down
Loading