Skip to content

Commit

Permalink
Clarify docs on EventLoopFuture/assumeIsolatedUnsafeUnchecked
Browse files Browse the repository at this point in the history
  • Loading branch information
hamzahrmalik committed Jan 14, 2025
1 parent e19202c commit 416f142
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions Sources/NIOCore/EventLoopFuture+AssumeIsolated.swift
Original file line number Diff line number Diff line change
Expand Up @@ -606,11 +606,10 @@ extension EventLoopFuture {
/// Returns a variant of this ``EventLoopFuture`` with less strict
/// `Sendable` requirements. Can only be called from on the
/// ``EventLoop`` to which this ``EventLoopFuture`` is bound, will crash
/// if that invariant fails to be met.
/// if that invariant fails to be met in debug builds.
///
/// This is an unsafe version of ``EventLoopFuture/assumeIsolated()`` which
/// omits the runtime check in release builds and doesn't prevent you using it
/// from using it in async contexts.
/// omits the runtime check in release builds.
@inlinable
@available(*, noasync)
public func assumeIsolatedUnsafeUnchecked() -> Isolated {
Expand Down

0 comments on commit 416f142

Please sign in to comment.