Structureswift-nio 2.81.0NIOCore
Mode
Mode represents file access modes.
struct ModeMode represents file access modes.
struct Modeimport NIOCoreThe core abstractions that make up SwiftNIO.
final class NIOFileHandleDeprecated. NIOFileHandle is a handle to an open file descriptor.
convenience init(_deprecatedPath path: String) throws Open a new NIOFileHandle. This operation is blocking.
convenience init(_deprecatedPath path: String, mode: Mode = .read, flags: 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.
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: Mode = .read, flags: Flags = .default) throws Open a new NIOFileHandle. This operation is blocking.
protocol EquatableA type that can be compared for value equality.
protocol ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol OptionSet : RawRepresentable, SetAlgebraA type that presents a mathematical set interface to a bit set.
protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
protocol Sendableprotocol SetAlgebra<Element> : Equatable, ExpressibleByArrayLiteralA type that provides mathematical set operations.
init(rawValue: UInt8) static let read: NIOFileHandle.ModeOpens file for reading
static let write: NIOFileHandle.ModeOpens file for writing
let rawValue: UInt8init() Creates an empty option set.
init<S>(_ sequence: S) where S : Sequence, Self.Element == S.Element Creates a new set from a finite sequence of items.
init(arrayLiteral: Self.Element...) Creates a set containing the elements of the given array literal.
var isEmpty: Bool { get }A Boolean value that indicates whether the set has no elements.
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
func contains(_ member: Self) -> Bool Returns a Boolean value that indicates whether a given element is a member of the option set.
mutating func formIntersection(_ other: Self) Removes all elements of this option set that are not also present in the given set.
mutating func formSymmetricDifference(_ other: Self) Replaces this set with a new set containing all elements contained in either this set or the given set, but not in both.
mutating func formUnion(_ other: Self) Inserts the elements of another set into this option set.
@discardableResult mutating func insert(_ newMember: Self.Element) -> (inserted: Bool, memberAfterInsert: Self.Element) Adds the given element to the option set if it is not already a member.
func intersection(_ other: Self) -> Self Returns a new option set with only the elements contained in both this set and the given set.
func isDisjoint(with other: Self) -> Bool Returns a Boolean value that indicates whether the set has no members in common with the given set.
func isStrictSubset(of other: Self) -> Bool Returns a Boolean value that indicates whether this set is a strict subset of the given set.
func isStrictSuperset(of other: Self) -> Bool Returns a Boolean value that indicates whether this set is a strict superset of the given set.
func isSubset(of other: Self) -> Bool Returns a Boolean value that indicates whether the set is a subset of another set.
func isSuperset(of other: Self) -> Bool Returns a Boolean value that indicates whether the set is a superset of the given set.
@discardableResult mutating func remove(_ member: Self.Element) -> Self.Element? Removes the given element and all elements subsumed by it.
mutating func subtract(_ other: Self) Removes the elements of the given set from this set.
func subtracting(_ other: Self) -> Self Returns a new set containing the elements of this set that do not occur in the given set.
func symmetricDifference(_ other: Self) -> Self Returns a new option set with the elements contained in this set or in the given set, but not in both.
func union(_ other: Self) -> Self Returns a new option set of the elements contained in this set, in the given set, or in both.
@discardableResult mutating func update(with newMember: Self.Element) -> Self.Element? Inserts the given element into the set.