Options for opening a file for writing (or reading and writing).
struct WriteYou can use the following methods to create commonly used sets of options:
newFile(replaceExisting:permissions:) to create a new file, optionally replacing one which already exists.
modifyFile(createIfNecessary:permissions:) to modify an existing file, optionally creating it if it doesn’t exist.
import _NIOFileSystemA file system library for Swift.
enum OpenOptionsOptions for opening file handles.
static func newFile(replaceExisting: Bool, permissions: FilePermissions? = nil) -> OpenOptions.Write Create a new file for writing to.
static func modifyFile(createIfNecessary: Bool, permissions: FilePermissions? = nil) -> OpenOptions.Write Opens a file for modifying.
struct DirectoryOptions for opening a directory.
enum ExistingFileOptions for opening an existing file.
struct NewFileOptions for creating a new file.
struct ReadOptions for opening a file for reading.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Sendable : SendableMetatypeA 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.
protocol SendableMetatype : ~Copyable, ~EscapableA type whose metatype can be shared across arbitrary concurrent contexts without introducing a risk of data races. When a generic type T conforms to SendableMetatype, its metatype T.Type conforms to Sendable. All concrete types implicitly conform to the SendableMetatype protocol, so its primary purpose is in generic code to prohibit the use of isolated conformances along with the generic type.
init(existingFile: OpenOptions.ExistingFile, newFile: OpenOptions.NewFile?, followSymbolicLinks: Bool = true, closeOnExec: Bool = false) Creates a new set of options for opening a directory.
var closeOnExec: BoolMarks the descriptor of the opened file as ‘close-on-exec’.
var existingFile: OpenOptions.ExistingFileThe behavior for opening an existing file.
var followSymbolicLinks: BoolIf the last path component is a symbolic link then this flag determines whether the link is followed. If false and the last path component is a symbolic link then an error is thrown.
var newFile: OpenOptions.NewFile?The creation options for a new file, if one should be created. nil means that no file should be created.
var permissionsForRegularFile: FilePermissions? { get }static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.