Deprecated. NIOFileHandle is a handle to an open file descriptor.
final class NIOFileHandleWhen creating a NIOFileHandle it takes ownership of the underlying file descriptor. When a NIOFileHandle is no longer needed you must close it or take back ownership of the file descriptor using takeDescriptorOwnership.
import NIOCoreThe core abstractions that make up SwiftNIO.
struct ByteBufferByteBuffer stores contiguously allocated raw bytes. It is a random and sequential accessible sequence of zero or more bytes (octets).
struct ByteBufferViewA view into a portion of a ByteBuffer.
struct ByteBufferAllocatorThe preferred allocator for ByteBuffer values. The allocation strategy is opaque but is currently libc’s malloc, realloc and free.
enum EndiannessEndianness refers to the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.
protocol FileDescriptorstruct FileRegionA FileRegion represent a readable portion usually created to be sent over the network.
typealias NIOPOSIXFileMode = mode_tenum IODataIOData unifies standard SwiftNIO types that are raw bytes of data; currently ByteBuffer and FileRegion.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol Escapableprotocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
convenience init(_deprecatedPath path: String) throws Open a new NIOFileHandle. This operation is blocking.
convenience init(_deprecatedPath path: String, mode: NIOFileHandle.Mode = .read, flags: NIOFileHandle.Flags = .default) throws Open a new NIOFileHandle. This operation is blocking.
init(_deprecatedTakingOwnershipOfDescriptor descriptor: CInt) Create a NIOFileHandle taking ownership of descriptor. You must call NIOFileHandle.close or NIOFileHandle.takeDescriptorOwnership before this object can be safely released.
var description: String { get }var isOpen: Bool { get }func close() throws func duplicate() throws -> NIOFileHandle Duplicates this NIOFileHandle. This means that a new NIOFileHandle object with a new underlying file descriptor is returned. The caller takes ownership of the returned NIOFileHandle and is responsible for closing it.
func takeDescriptorOwnership() throws -> CInt Take the ownership of the underlying file descriptor. This is similar to close() but the underlying file descriptor remains open. The caller is responsible for closing the file descriptor by some other means.
func withUnsafeFileDescriptor<T>(_ body: (CInt) throws -> T) throws -> T struct FlagsFlags allows to specify additional flags to Mode, such as permission for file creation.
struct ModeMode represents file access modes.
convenience init(descriptor: CInt) Create a NIOFileHandle taking ownership of descriptor. You must call NIOFileHandle.close or NIOFileHandle.takeDescriptorOwnership before this object can be safely released.
convenience init(path: String) throws Open a new NIOFileHandle. This operation is blocking.
convenience init(path: String, mode: NIOFileHandle.Mode = .read, flags: NIOFileHandle.Flags = .default) throws Open a new NIOFileHandle. This operation is blocking.