Note that certain NIOFileHandle.init overloads are blocking (#1630)

This was noted in review  of swift-server/async-http-client#275, but I don't think that this was clearly stated in the documentation.
This commit is contained in:
Max Desiatov 2020-09-07 10:48:15 +01:00 committed by GitHub
parent 98721c75b0
commit 96db8838be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -134,7 +134,7 @@ extension NIOFileHandle {
}
}
/// Open a new `NIOFileHandle`.
/// Open a new `NIOFileHandle`. This operation is blocking.
///
/// - parameters:
/// - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.
@ -145,7 +145,7 @@ extension NIOFileHandle {
self.init(descriptor: fd)
}
/// Open a new `NIOFileHandle`.
/// Open a new `NIOFileHandle`. This operation is blocking.
///
/// - parameters:
/// - path: The path of the file to open. The ownership of the file descriptor is transferred to this `NIOFileHandle` and so it will be closed once `close` is called.