Crate objc2_fs_kit

Bindings to the FSKit framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

FSAccessMaskFSVolume

A bitmask of access rights.

FSBlockDeviceResourceFSResource

A resource that represents a block storage disk partition.

FSBlockmapFlagsFSVolumeExtent

Flags that describe the behavior of a blockmap operation.

FSClientFSClient

An interface for apps and daemons to interact with FSKit.

FSCompleteIOFlagsFSVolumeExtent

Flags that describe the behavior of an I/O completion operation.

FSContainerIdentifierFSContainer and FSEntityIdentifier

A type that identifies a container.

FSContainerStateFSContainer

An enumeration of container state values.

FSContainerStatusFSContainer

A type that represents a container’s status.

FSDeactivateOptionsFSVolume

Options that affect the behavior of deactivate methods.

FSDirectoryEntryPackerFSVolume

An object used to provide items during a directory enumeration.

FSEntityIdentifierFSEntityIdentifier

A base type that identifies containers and volumes.

FSErrorCodeFSKitError

A code that indicates a specific FSKit error.

FSExtentPackerFSVolumeExtent

A type that directs the kernel to map space on disk to a specific file managed by this file system.

FSExtentTypeFSVolumeExtent

An enumeration of types of extents.

FSFileNameFSFileName

The name of a file, expressed as a data buffer.

FSFileSystemFSFileSystem

An abstract base class for implementing a full-featured file system.

FSItemFSItem

A distinct object in a file hierarchy, such as a file, directory, symlink, socket, and more.

FSItemAttributeFSItem

A value that indicates a set of item attributes to get or set.

FSItemAttributesFSItem

Attributes of an item, such as size, creation and modification times, and user and group identifiers.

FSItemDeactivationOptionsFSVolume

Options to specify the item deactivation policy.

FSItemGetAttributesRequestFSItem

A request to get attributes from an item.

FSItemIDFSItem

Apple’s documentation

FSItemSetAttributesRequestFSItem

A request to set attributes on an item.

FSItemTypeFSItem

An enumeration of item types, such as file, directory, or symbolic link.

FSMatchResultFSResource

A type that represents the recognition and usability of a probed resource.

FSMetadataRangeFSResource

A range that describes contiguous metadata segments on disk.

FSModuleIdentityFSModuleIdentity

An installed file system module.

FSMutableFileDataBufferFSMutableFileDataBuffer

A wrapper object for a data buffer.

FSPreallocateFlagsFSVolume

Behavior flags for preallocation operations.

FSProbeResultFSResource

An object that represents the results of a specific probe.

FSResourceFSResource

An abstract resource a file system uses to provide data for a volume.

FSSetXattrPolicyFSVolume

Flags to specify the policy when setting extended file attributes.

FSStatFSResultFSVolume

A type used to report a volume’s statistics.

FSSyncFlagsFSVolume

Behavior flags for use with synchronization calls.

FSTaskFSTask

A class that enables a file system module to pass log messages and completion notifications to clients.

FSTaskOptionsFSTaskOptions

A class that passes command options to a task, optionally providing security-scoped URLs.

FSUnaryFileSystemFSUnaryFileSystem

An abstract base class for implementing a minimal file system.

FSVolumeFSVolume

A directory structure for files and folders.

FSVolumeCaseFormatFSVolume

An enumeration of case-sensitivity support types.

FSVolumeIdentifierFSEntityIdentifier and FSVolume

A type that identifies a volume.

FSVolumeOpenModesFSVolume

Defined modes for opening a file.

FSVolumeSupportedCapabilitiesFSVolume

A type that represents capabillities supported by a volume, such as hard and symbolic links, journaling, and large file sizes.

Statics

FSDirectoryCookieInitial^⚠FSVolume

The constant initial value for the directory-enumeration cookie.

FSDirectoryVerifierInitial^⚠FSVolume

The constant initial value for the directory-enumeration verifier.

FSKitErrorDomain^⚠FSKitError

An error domain for FSKit errors.

FSKitVersionNumber^⚠

Project version number for FSKit.

FSKitVersionString^⚠

Project version string for FSKit.

FSOperationIDUnspecified^⚠FSVolumeExtent

Apple’s documentation

Traits

FSFileSystemBaseFSFileSystemBase

A protocol containing functionality supplied by FSKit to file system implementations.

FSManageableResourceMaintenanceOperationsFSResource

Maintenance operations for a file system’s resources.

FSUnaryFileSystemOperationsFSUnaryFileSystem

Operations performed by a unary file system.

FSVolumeAccessCheckOperationsFSVolume

Methods and properties implemented by volumes that want to enforce access check operations.

FSVolumeItemDeactivationFSVolume

Methods and properties implemented by volumes that support deactivating items.

FSVolumeKernelOffloadedIOOperationsFSVolumeExtent

Methods and properties implemented by volumes that use kernel-offloaded I/O to achieve higher file transfer performance.

FSVolumeOpenCloseOperationsFSVolume

Methods and properties implemented by volumes that want to receive open and close calls for each item.

FSVolumeOperationsFSVolume

Methods that all volumes implement to provide required capabilities.

FSVolumePathConfOperationsFSVolume

Properties implemented by volumes that support providing the values of system limits or options.

FSVolumePreallocateOperationsFSVolume

Methods and properties implemented by volumes that want to offer preallocation functions.

FSVolumeReadWriteOperationsFSVolume

Methods implemented for read and write operations that deliver data to and from the extension.

FSVolumeRenameOperationsFSVolume

Methods and properties implemented by volumes that support renaming the volume.

FSVolumeXattrOperationsFSVolume

Methods and properties implemented by volumes that natively or partially support extended attributes.

Functions

fs_errorForCocoaError^⚠FSKitFunctions

Creates an error object for the given Cocoa error code.

fs_errorForMachError^⚠FSKitFunctions

Creates an error object for the given Mach error code.

fs_errorForPOSIXError^⚠FSKitFunctions

Creates an error object for the given POSIX error code.

Type Aliases

FSDirectoryCookieFSVolume

A value that indicates a location in a directory from which to enumerate.

FSDirectoryVerifierFSVolume

A tool to detect whether the directory contents changed since the last call to enumerate a directory.

FSOperationIDFSVolumeExtent

A unique identifier for an operation.