Skip to content

Commit

Permalink
Docs clarification
Browse files Browse the repository at this point in the history
  • Loading branch information
Lukasa committed Nov 18, 2024
1 parent 4714b90 commit d3dc7b9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Sources/NIOCore/EventLoopFuture+AssumeIsolated.swift
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ extension EventLoop {
/// Assumes the calling context is isolated to the event loop.
///
/// This version of ``EventLoop/assumeIsolated()`` omits the runtime
/// isolation check in release builds. It retains it in debug mode to
/// ensure correctness.
/// isolation check in release builds and doesn't prevent you using it
/// from using it in async contexts.
@inlinable
public func assumeIsolatedUnsafeUnchecked() -> NIOIsolatedEventLoop {
self.assertInEventLoop()
Expand Down Expand Up @@ -524,8 +524,8 @@ extension EventLoopFuture {
/// if that invariant fails to be met.
///
/// This is an unsafe version of ``EventLoopFuture/assumeIsolated()`` which
/// omits the runtime check in release builds. This improves performance, but
/// should only be used sparingly.
/// omits the runtime check in release builds and doesn't prevent you using it
/// from using it in async contexts.
@inlinable
@available(*, noasync)
public func assumeIsolatedUnsafeUnchecked() -> Isolated {
Expand Down Expand Up @@ -616,8 +616,8 @@ extension EventLoopPromise {
/// if that invariant fails to be met.
///
/// This is an unsafe version of ``EventLoopPromise/assumeIsolated()`` which
/// omits the runtime check in release builds. This improves performance, but
/// should only be used sparingly.
/// omits the runtime check in release builds and doesn't prevent you using it
/// from using it in async contexts.
@inlinable
public func assumeIsolatedUnsafeUnchecked() -> Isolated {
self.futureResult.eventLoop.assertInEventLoop()
Expand Down

0 comments on commit d3dc7b9

Please sign in to comment.