Documentation
¶
Overview ¶
Package fskit provides purego-based Go bindings for the macOS FSKit framework.
Apple documentation: https://developer.apple.com/documentation/fskit
Index ¶
- func FSDirectoryCookieInitial() uint64
- func FSDirectoryVerifierInitial() uint64
- func FSKitErrorDomain() *foundation.NSString
- func FSKitVersionNumber() float64
- func FSKitVersionString() []unsafe.Pointer
- func FSOperationIDUnspecified() uint
- func FsErrorForCocoaError(errorCode int) unsafe.Pointer
- func FsErrorForMachError(errorCode int) unsafe.Pointer
- func FsErrorForPOSIXError(arg int) unsafe.Pointer
- func SymbolAvailable(symbol string) bool
- type Acl_entry_id_t
- type Acl_flag_t
- type Acl_perm_t
- type Acl_tag_t
- type Acl_type_t
- type Clockid_t
- type Dispatch_autorelease_frequency_t
- type Dispatch_block_flags_t
- type FSAccessMask
- type FSBlockDeviceResource
- func (o *FSBlockDeviceResource) AsynchronousMetadataFlushWithError() (bool, error)
- func (o *FSBlockDeviceResource) BSDName() *foundation.NSString
- func (o *FSBlockDeviceResource) BlockCount() uint64
- func (o *FSBlockDeviceResource) BlockSize() uint64
- func (o *FSBlockDeviceResource) DelayedMetadataWriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
- func (o *FSBlockDeviceResource) IsWritable() bool
- func (o *FSBlockDeviceResource) MetadataClearWithDelayedWritesError(rangesToClear *foundation.NSArray[*FSMetadataRange], withDelayedWrites bool) (bool, error)
- func (o *FSBlockDeviceResource) MetadataFlushWithError() (bool, error)
- func (o *FSBlockDeviceResource) MetadataPurgeError(rangesToPurge *foundation.NSArray[*FSMetadataRange]) (bool, error)
- func (o *FSBlockDeviceResource) MetadataReadIntoStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
- func (o *FSBlockDeviceResource) MetadataWriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
- func (o *FSBlockDeviceResource) PhysicalBlockSize() uint64
- func (o *FSBlockDeviceResource) ReadIntoStartingAtLengthCompletionHandler(buffer unsafe.Pointer, offset int64, length uint, ...)
- func (o *FSBlockDeviceResource) ReadIntoStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (uint, error)
- func (o *FSBlockDeviceResource) WriteFromStartingAtLengthCompletionHandler(buffer unsafe.Pointer, offset int64, length uint, ...)
- func (o *FSBlockDeviceResource) WriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (uint, error)
- type FSBlockmapFlags
- type FSClient
- type FSCompleteIOFlags
- type FSContainerIdentifier
- type FSContainerState
- type FSContainerStatus
- func FSContainerStatusActive() *FSContainerStatus
- func FSContainerStatusActiveWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
- func FSContainerStatusBlockedWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
- func FSContainerStatusFromID(id objc.ID) *FSContainerStatus
- func FSContainerStatusNotReadyWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
- func FSContainerStatusReady() *FSContainerStatus
- func FSContainerStatusReadyWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
- type FSDeactivateOptions
- type FSDirectoryEntryPacker
- type FSEntityIdentifier
- func (o *FSEntityIdentifier) Init() *FSEntityIdentifier
- func (o *FSEntityIdentifier) InitWithUUID(uuid *foundation.NSUUID) *FSEntityIdentifier
- func (o *FSEntityIdentifier) InitWithUUIDData(uuid *foundation.NSUUID, qualifierData *foundation.NSData) *FSEntityIdentifier
- func (o *FSEntityIdentifier) InitWithUUIDQualifier(uuid *foundation.NSUUID, qualifier uint64) *FSEntityIdentifier
- func (o *FSEntityIdentifier) Qualifier() *foundation.NSData
- func (o *FSEntityIdentifier) SetQualifier(qualifier *foundation.NSData)
- func (o *FSEntityIdentifier) SetUuid(uuid *foundation.NSUUID)
- func (o *FSEntityIdentifier) Uuid() *foundation.NSUUID
- type FSErrorCode
- type FSExtentPacker
- type FSExtentType
- type FSFileName
- func FSFileNameFromID(id objc.ID) *FSFileName
- func FSFileNameNameWithBytesLength(bytes_ string, length uint) *FSFileName
- func FSFileNameNameWithCString(name string) *FSFileName
- func FSFileNameNameWithData(name *foundation.NSData) *FSFileName
- func FSFileNameNameWithString(name *foundation.NSString) *FSFileName
- func (o *FSFileName) Data() *foundation.NSData
- func (o *FSFileName) InitWithBytesLength(bytes_ string, length uint) *FSFileName
- func (o *FSFileName) InitWithCString(name string) *FSFileName
- func (o *FSFileName) InitWithData(name *foundation.NSData) *FSFileName
- func (o *FSFileName) InitWithString(name *foundation.NSString) *FSFileName
- func (o *FSFileName) String() *foundation.NSString
- type FSFileSystem
- type FSFileSystemBase
- type FSGenericURLResource
- type FSItem
- type FSItemAttribute
- type FSItemAttributes
- func (o *FSItemAttributes) AccessTime() unsafe.Pointer
- func (o *FSItemAttributes) AddedTime() unsafe.Pointer
- func (o *FSItemAttributes) AllocSize() uint64
- func (o *FSItemAttributes) BackupTime() unsafe.Pointer
- func (o *FSItemAttributes) BirthTime() unsafe.Pointer
- func (o *FSItemAttributes) ChangeTime() unsafe.Pointer
- func (o *FSItemAttributes) FileID() FSItemID
- func (o *FSItemAttributes) Flags() uint32
- func (o *FSItemAttributes) Gid() uint32
- func (o *FSItemAttributes) InhibitKernelOffloadedIO() bool
- func (o *FSItemAttributes) InvalidateAllProperties()
- func (o *FSItemAttributes) IsValid(attribute FSItemAttribute) bool
- func (o *FSItemAttributes) LinkCount() uint32
- func (o *FSItemAttributes) Mode() uint32
- func (o *FSItemAttributes) ModifyTime() unsafe.Pointer
- func (o *FSItemAttributes) ParentID() FSItemID
- func (o *FSItemAttributes) SetAccessTime(accessTime unsafe.Pointer)
- func (o *FSItemAttributes) SetAddedTime(addedTime unsafe.Pointer)
- func (o *FSItemAttributes) SetAllocSize(allocSize uint64)
- func (o *FSItemAttributes) SetBackupTime(backupTime unsafe.Pointer)
- func (o *FSItemAttributes) SetBirthTime(birthTime unsafe.Pointer)
- func (o *FSItemAttributes) SetChangeTime(changeTime unsafe.Pointer)
- func (o *FSItemAttributes) SetFileID(fileID FSItemID)
- func (o *FSItemAttributes) SetFlags(flags uint32)
- func (o *FSItemAttributes) SetGid(gid uint32)
- func (o *FSItemAttributes) SetInhibitKernelOffloadedIO(inhibitKernelOffloadedIO bool)
- func (o *FSItemAttributes) SetLinkCount(linkCount uint32)
- func (o *FSItemAttributes) SetMode(mode uint32)
- func (o *FSItemAttributes) SetModifyTime(modifyTime unsafe.Pointer)
- func (o *FSItemAttributes) SetParentID(parentID FSItemID)
- func (o *FSItemAttributes) SetSize(size uint64)
- func (o *FSItemAttributes) SetSupportsLimitedXAttrs(supportsLimitedXAttrs bool)
- func (o *FSItemAttributes) SetType(type_ FSItemType)
- func (o *FSItemAttributes) SetUid(uid uint32)
- func (o *FSItemAttributes) Size() uint64
- func (o *FSItemAttributes) SupportsLimitedXAttrs() bool
- func (o *FSItemAttributes) Type() FSItemType
- func (o *FSItemAttributes) Uid() uint32
- type FSItemDeactivationOptions
- type FSItemGetAttributesRequest
- type FSItemID
- type FSItemSetAttributesRequest
- type FSItemType
- type FSManageableResourceMaintenanceOperations
- type FSMatchResult
- type FSMetadataRange
- type FSModuleIdentity
- type FSMountOptions
- type FSMutableFileDataBuffer
- type FSPathURLResource
- type FSPreallocateFlags
- type FSProbeResult
- func FSProbeResultFromID(id objc.ID) *FSProbeResult
- func FSProbeResultNotRecognizedProbeResult() *FSProbeResult
- func FSProbeResultRecognizedProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
- func FSProbeResultUsableButLimitedProbeResult() *FSProbeResult
- func FSProbeResultUsableButLimitedProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
- func FSProbeResultUsableProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
- type FSResource
- type FSSetXattrPolicy
- type FSStatFSResult
- func (o *FSStatFSResult) AvailableBlocks() uint64
- func (o *FSStatFSResult) AvailableBytes() uint64
- func (o *FSStatFSResult) BlockSize() int
- func (o *FSStatFSResult) FileSystemSubType() int
- func (o *FSStatFSResult) FileSystemTypeName() *foundation.NSString
- func (o *FSStatFSResult) FreeBlocks() uint64
- func (o *FSStatFSResult) FreeBytes() uint64
- func (o *FSStatFSResult) FreeFiles() uint64
- func (o *FSStatFSResult) InitWithFileSystemTypeName(fileSystemTypeName *foundation.NSString) *FSStatFSResult
- func (o *FSStatFSResult) IoSize() int
- func (o *FSStatFSResult) SetAvailableBlocks(availableBlocks uint64)
- func (o *FSStatFSResult) SetAvailableBytes(availableBytes uint64)
- func (o *FSStatFSResult) SetBlockSize(blockSize int)
- func (o *FSStatFSResult) SetFileSystemSubType(fileSystemSubType int)
- func (o *FSStatFSResult) SetFreeBlocks(freeBlocks uint64)
- func (o *FSStatFSResult) SetFreeBytes(freeBytes uint64)
- func (o *FSStatFSResult) SetFreeFiles(freeFiles uint64)
- func (o *FSStatFSResult) SetIoSize(ioSize int)
- func (o *FSStatFSResult) SetTotalBlocks(totalBlocks uint64)
- func (o *FSStatFSResult) SetTotalBytes(totalBytes uint64)
- func (o *FSStatFSResult) SetTotalFiles(totalFiles uint64)
- func (o *FSStatFSResult) SetUsedBlocks(usedBlocks uint64)
- func (o *FSStatFSResult) SetUsedBytes(usedBytes uint64)
- func (o *FSStatFSResult) TotalBlocks() uint64
- func (o *FSStatFSResult) TotalBytes() uint64
- func (o *FSStatFSResult) TotalFiles() uint64
- func (o *FSStatFSResult) UsedBlocks() uint64
- func (o *FSStatFSResult) UsedBytes() uint64
- type FSSyncFlags
- type FSTask
- type FSTaskOptions
- type FSUnaryFileSystem
- type FSUnaryFileSystemOperations
- type FSVolume
- type FSVolumeAccessCheckOperations
- type FSVolumeCaseFormat
- type FSVolumeIdentifier
- type FSVolumeItemDeactivation
- type FSVolumeKernelOffloadedIOOperations
- type FSVolumeOpenCloseOperations
- type FSVolumeOpenModes
- type FSVolumeOperations
- type FSVolumePathConfOperations
- type FSVolumePreallocateOperations
- type FSVolumeReadWriteOperations
- type FSVolumeRenameOperations
- type FSVolumeSupportedCapabilities
- func (o *FSVolumeSupportedCapabilities) CaseFormat() FSVolumeCaseFormat
- func (o *FSVolumeSupportedCapabilities) DoesNotSupportImmutableFiles() bool
- func (o *FSVolumeSupportedCapabilities) DoesNotSupportRootTimes() bool
- func (o *FSVolumeSupportedCapabilities) DoesNotSupportSettingFilePermissions() bool
- func (o *FSVolumeSupportedCapabilities) DoesNotSupportVolumeSizes() bool
- func (o *FSVolumeSupportedCapabilities) SetCaseFormat(caseFormat FSVolumeCaseFormat)
- func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportImmutableFiles(doesNotSupportImmutableFiles bool)
- func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportRootTimes(doesNotSupportRootTimes bool)
- func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportSettingFilePermissions(doesNotSupportSettingFilePermissions bool)
- func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportVolumeSizes(doesNotSupportVolumeSizes bool)
- func (o *FSVolumeSupportedCapabilities) SetSupports2TBFiles(supports2TBFiles bool)
- func (o *FSVolumeSupportedCapabilities) SetSupports64BitObjectIDs(supports64BitObjectIDs bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsActiveJournal(supportsActiveJournal bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsDocumentID(supportsDocumentID bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsFastStatFS(supportsFastStatFS bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsHardLinks(supportsHardLinks bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsHiddenFiles(supportsHiddenFiles bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsJournal(supportsJournal bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsOpenDenyModes(supportsOpenDenyModes bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsPersistentObjectIDs(supportsPersistentObjectIDs bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsSharedSpace(supportsSharedSpace bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsSparseFiles(supportsSparseFiles bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsSymbolicLinks(supportsSymbolicLinks bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsVolumeGroups(supportsVolumeGroups bool)
- func (o *FSVolumeSupportedCapabilities) SetSupportsZeroRuns(supportsZeroRuns bool)
- func (o *FSVolumeSupportedCapabilities) Supports2TBFiles() bool
- func (o *FSVolumeSupportedCapabilities) Supports64BitObjectIDs() bool
- func (o *FSVolumeSupportedCapabilities) SupportsActiveJournal() bool
- func (o *FSVolumeSupportedCapabilities) SupportsDocumentID() bool
- func (o *FSVolumeSupportedCapabilities) SupportsFastStatFS() bool
- func (o *FSVolumeSupportedCapabilities) SupportsHardLinks() bool
- func (o *FSVolumeSupportedCapabilities) SupportsHiddenFiles() bool
- func (o *FSVolumeSupportedCapabilities) SupportsJournal() bool
- func (o *FSVolumeSupportedCapabilities) SupportsOpenDenyModes() bool
- func (o *FSVolumeSupportedCapabilities) SupportsPersistentObjectIDs() bool
- func (o *FSVolumeSupportedCapabilities) SupportsSharedSpace() bool
- func (o *FSVolumeSupportedCapabilities) SupportsSparseFiles() bool
- func (o *FSVolumeSupportedCapabilities) SupportsSymbolicLinks() bool
- func (o *FSVolumeSupportedCapabilities) SupportsVolumeGroups() bool
- func (o *FSVolumeSupportedCapabilities) SupportsZeroRuns() bool
- type FSVolumeXattrOperations
- type Filesec_property_t
- type Idtype_t
- type Ipc_info_object_type_t
- type Launch_data_type_t
- type MDLabelDomain
- type MDQueryOptionFlags
- type MDQuerySortOptionFlags
- type Mach_vm_range_flags_t
- type Mach_vm_range_flavor_t
- type Mach_vm_range_tag_t
- type Mpo_flags_t
- type Os_clockid_t
- type Os_log_type_t
- type Ptrauth_key
- type Qos_class_t
- type Virtual_memory_guard_exception_code_t
- type Xpc_listener_create_flags_t
- type Xpc_session_create_flags_t
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FSDirectoryCookieInitial ¶
func FSDirectoryCookieInitial() uint64
func FSDirectoryVerifierInitial ¶
func FSDirectoryVerifierInitial() uint64
func FSKitErrorDomain ¶
func FSKitErrorDomain() *foundation.NSString
func FSKitVersionNumber ¶
func FSKitVersionNumber() float64
func FSKitVersionString ¶
func FSOperationIDUnspecified ¶
func FSOperationIDUnspecified() uint
func FsErrorForCocoaError ¶
Creates an error object for the given Cocoa error code. C function: fs_errorForCocoaError
func FsErrorForMachError ¶
Creates an error object for the given Mach error code. C function: fs_errorForMachError
func FsErrorForPOSIXError ¶
Creates an error object for the given POSIX error code. C function: fs_errorForPOSIXError
func SymbolAvailable ¶
SymbolAvailable reports whether the named C symbol was bound when the library loaded. Calling a generated wrapper whose symbol is unavailable dereferences a nil function variable and panics.
Types ¶
type Acl_entry_id_t ¶
type Acl_entry_id_t int64
const ( ACL_FIRST_ENTRY Acl_entry_id_t = 0 ACL_NEXT_ENTRY Acl_entry_id_t = -1 ACL_LAST_ENTRY Acl_entry_id_t = -2 )
func (Acl_entry_id_t) String ¶
func (e Acl_entry_id_t) String() string
type Acl_flag_t ¶
type Acl_flag_t int64
const ( ACL_FLAG_DEFER_INHERIT Acl_flag_t = 1 ACL_FLAG_NO_INHERIT Acl_flag_t = 131072 ACL_ENTRY_INHERITED Acl_flag_t = 16 ACL_ENTRY_FILE_INHERIT Acl_flag_t = 32 ACL_ENTRY_DIRECTORY_INHERIT Acl_flag_t = 64 ACL_ENTRY_LIMIT_INHERIT Acl_flag_t = 128 ACL_ENTRY_ONLY_INHERIT Acl_flag_t = 256 )
func (Acl_flag_t) String ¶
func (e Acl_flag_t) String() string
type Acl_perm_t ¶
type Acl_perm_t int64
const ( ACL_READ_DATA Acl_perm_t = 2 ACL_LIST_DIRECTORY Acl_perm_t = 2 ACL_WRITE_DATA Acl_perm_t = 4 ACL_ADD_FILE Acl_perm_t = 4 ACL_EXECUTE Acl_perm_t = 8 ACL_SEARCH Acl_perm_t = 8 ACL_DELETE Acl_perm_t = 16 ACL_APPEND_DATA Acl_perm_t = 32 ACL_ADD_SUBDIRECTORY Acl_perm_t = 32 ACL_DELETE_CHILD Acl_perm_t = 64 ACL_READ_ATTRIBUTES Acl_perm_t = 128 ACL_WRITE_ATTRIBUTES Acl_perm_t = 256 ACL_READ_EXTATTRIBUTES Acl_perm_t = 512 ACL_WRITE_EXTATTRIBUTES Acl_perm_t = 1024 ACL_READ_SECURITY Acl_perm_t = 2048 ACL_WRITE_SECURITY Acl_perm_t = 4096 ACL_CHANGE_OWNER Acl_perm_t = 8192 ACL_SYNCHRONIZE Acl_perm_t = 1048576 )
func (Acl_perm_t) String ¶
func (e Acl_perm_t) String() string
type Acl_type_t ¶
type Acl_type_t int64
const ( ACL_TYPE_EXTENDED Acl_type_t = 256 ACL_TYPE_ACCESS Acl_type_t = 0 ACL_TYPE_DEFAULT Acl_type_t = 1 ACL_TYPE_AFS Acl_type_t = 2 ACL_TYPE_CODA Acl_type_t = 3 ACL_TYPE_NTFS Acl_type_t = 4 ACL_TYPE_NWFS Acl_type_t = 5 )
func (Acl_type_t) String ¶
func (e Acl_type_t) String() string
type Dispatch_autorelease_frequency_t ¶
type Dispatch_autorelease_frequency_t uint64
const ( DISPATCH_AUTORELEASE_FREQUENCY_INHERIT Dispatch_autorelease_frequency_t = 0 DISPATCH_AUTORELEASE_FREQUENCY_WORK_ITEM Dispatch_autorelease_frequency_t = 1 DISPATCH_AUTORELEASE_FREQUENCY_NEVER Dispatch_autorelease_frequency_t = 2 )
func (Dispatch_autorelease_frequency_t) String ¶
func (e Dispatch_autorelease_frequency_t) String() string
type Dispatch_block_flags_t ¶
type Dispatch_block_flags_t uint64
const ( DISPATCH_BLOCK_BARRIER Dispatch_block_flags_t = 1 DISPATCH_BLOCK_DETACHED Dispatch_block_flags_t = 2 DISPATCH_BLOCK_ASSIGN_CURRENT Dispatch_block_flags_t = 4 DISPATCH_BLOCK_NO_QOS_CLASS Dispatch_block_flags_t = 8 DISPATCH_BLOCK_INHERIT_QOS_CLASS Dispatch_block_flags_t = 16 DISPATCH_BLOCK_ENFORCE_QOS_CLASS Dispatch_block_flags_t = 32 )
func (Dispatch_block_flags_t) String ¶
func (e Dispatch_block_flags_t) String() string
type FSAccessMask ¶
type FSAccessMask uint64
const ( // The file system allows reading data. FSAccessReadData FSAccessMask = 2 // The file system allows listing directory contents. FSAccessListDirectory FSAccessMask = 2 // The file system allows writing data. FSAccessWriteData FSAccessMask = 4 // The file system allows adding files. FSAccessAddFile FSAccessMask = 4 // The file system allows file executuion. FSAccessExecute FSAccessMask = 8 // The file system allows searching files. FSAccessSearch FSAccessMask = 8 // The file system allows deleting a file. FSAccessDelete FSAccessMask = 16 // The file system allows appending data to a file. FSAccessAppendData FSAccessMask = 32 // The file system allows adding subdirectories. FSAccessAddSubdirectory FSAccessMask = 32 // The file system allows deleting subdirectories. FSAccessDeleteChild FSAccessMask = 64 // The file system allows reading file attributes. FSAccessReadAttributes FSAccessMask = 128 // The file system allows writing file attributes. FSAccessWriteAttributes FSAccessMask = 256 // The file system allows reading extended file attributes. FSAccessReadXattr FSAccessMask = 512 // The file system allows writing extended file attributes. FSAccessWriteXattr FSAccessMask = 1024 // The file system allows reading a file's security descriptors. FSAccessReadSecurity FSAccessMask = 2048 // The file system allows writing a file's security descriptors. FSAccessWriteSecurity FSAccessMask = 4096 // The file system allows taking ownership of a file. FSAccessTakeOwnership FSAccessMask = 8192 )
func (FSAccessMask) String ¶
func (e FSAccessMask) String() string
type FSBlockDeviceResource ¶
type FSBlockDeviceResource struct {
FSResource
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsblockdeviceresource
func FSBlockDeviceResourceFromID ¶
func FSBlockDeviceResourceFromID(id objc.ID) *FSBlockDeviceResource
func (*FSBlockDeviceResource) AsynchronousMetadataFlushWithError ¶
func (o *FSBlockDeviceResource) AsynchronousMetadataFlushWithError() (bool, error)
Asynchronously flushes the resource's buffer cache. This method schedules a flush of data previously written with “delayedMetadataWriteFrom:startingAt:length:error:“ to the resource and returns immediately without blocking. This method doesn't wait to check the flush's status. If an error prevents the flush from being scheduled, the error is indicated by the in-out `error` parameter. - Parameter error: On return, any error encountered while writing data, or `nil` if no error occurred. - Returns: A Boolean value indicating whether scheduling the metadata flush succeeded.
func (*FSBlockDeviceResource) BSDName ¶
func (o *FSBlockDeviceResource) BSDName() *foundation.NSString
The device name of the resource.
func (*FSBlockDeviceResource) BlockCount ¶
func (o *FSBlockDeviceResource) BlockCount() uint64
The block count on this resource.
func (*FSBlockDeviceResource) BlockSize ¶
func (o *FSBlockDeviceResource) BlockSize() uint64
The logical block size, the size of data blocks used by the file system. This is equivalent to the `DKIOCGETBLOCKSIZE` device parameter.
func (*FSBlockDeviceResource) DelayedMetadataWriteFromStartingAtLengthError ¶
func (o *FSBlockDeviceResource) DelayedMetadataWriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
Writes file system metadata from a buffer to a cache, prior to flushing it to the resource. This method provides access to the Kernel Buffer Cache, which is the primary system cache for file system metadata. Unlike equivalent kernel APIs, this method doesn't hold any kernel-level claim to the underlying buffers. This method is equivalent to “metadataWriteFrom:startingAt:length:error:“, except that it writes data to the resource's buffer cache instead of writing to disk immediately. To ensure writing data to disk, the client must flush the metadata by calling “metadataFlushWithError:“ or “asynchronousMetadataFlushWithError:“. Delayed writes offer two significant advantages: - Delayed writes are more performant, since the file system can avoid waiting for the actual write, reducing I/O latency. - When writing to a specific range repeatedly, delayed writes allow the file system to flush data to the disk only when necessary. This reduces disk usage by eliminating unnecessary writes. For the write to succeed, requests must conform to any transfer requirements of the underlying resource. Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets. This method doesn't support partial writing of metadata. - Parameters: - buffer: A buffer to provide the data. - offset: The offset into the resource from which to start writing. - length: The number of bytes to writing. - error: On return, any error encountered while writing data, or `nil` if no error occurred. - Returns: A Boolean value indicating whether the metadata write succeeded.
func (*FSBlockDeviceResource) IsWritable ¶
func (o *FSBlockDeviceResource) IsWritable() bool
func (*FSBlockDeviceResource) MetadataClearWithDelayedWritesError ¶
func (o *FSBlockDeviceResource) MetadataClearWithDelayedWritesError(rangesToClear *foundation.NSArray[*FSMetadataRange], withDelayedWrites bool) (bool, error)
Clears the given ranges within the buffer cache. This method clears the specified ranges in the resource’s buffer cache by writing zeroes into them. - Parameters: - rangesToClear: The metadata ranges to clear. - withDelayedWrites: A Boolean value that determines whether to perform the clear operation with delayed writes. The delay works in the same manner as “delayedMetadataWriteFrom:startingAt:length:error:“. When using delayed writes, the client can flush the metadata with “metadataFlushWithError:“ or “asynchronousMetadataFlushWithError:“. The system also flushes stale data in the buffer cache periodically. - error: On return, any error encountered while writing data, or `nil` if no error occurred. This value is `EINVAL` if `rangesToClear` is invalid. - Returns: A Boolean value indicating whether clearing the metadata succeeded.
func (*FSBlockDeviceResource) MetadataFlushWithError ¶
func (o *FSBlockDeviceResource) MetadataFlushWithError() (bool, error)
Synchronously flushes the resource's buffer cache. This method flushes data previously written with “delayedMetadataWriteFrom:startingAt:length:error:“ to the resource. - Parameter error: On return, any error encountered while writing data, or `nil` if no error occurred. - Returns: A Boolean value indicating whether the metadata flush succeeded.
func (*FSBlockDeviceResource) MetadataPurgeError ¶
func (o *FSBlockDeviceResource) MetadataPurgeError(rangesToPurge *foundation.NSArray[*FSMetadataRange]) (bool, error)
Synchronously purges the given ranges from the buffer cache. This method removes the given ranges from the resource's buffer cache. This process drops any dirty data in the cache, preventing the data from reaching the device. - Parameters: - rangesToPurge: The metadata ranges to purge. - error: On return, any error encountered while writing data, or `nil` if no error occurred. This value is `EINVAL` if `rangesToPurge` is invalid. - Returns: A Boolean value indicating whether purging the metadata succeeded.
func (*FSBlockDeviceResource) MetadataReadIntoStartingAtLengthError ¶
func (o *FSBlockDeviceResource) MetadataReadIntoStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
Synchronously reads file system metadata from the resource into a buffer. This method provides access to the Kernel Buffer Cache, which is the primary system cache for file system metadata. Unlike equivalent kernel APIs, this method doesn't hold any kernel-level claim to the underlying buffers. For the read to succeed, requests must conform to any transfer requirements of the underlying resource. Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets. This method doesn't support partial reading of metadata. - Parameters: - buffer: A buffer to receive the data. - offset: The offset into the resource from which to start reading. - length: The number of bytes to read. - error: On return, any error encountered while reading data, or `nil` if no error occurred. - Returns: A Boolean value indicating whether the metadata read succeeded.
func (*FSBlockDeviceResource) MetadataWriteFromStartingAtLengthError ¶
func (o *FSBlockDeviceResource) MetadataWriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (bool, error)
Synchronously writes file system metadata from a buffer to the resource. This method provides access to the Kernel Buffer Cache, which is the primary system cache for file system metadata. Unlike equivalent kernel APIs, this method doesn't hold any kernel-level claim to the underlying buffers. For the write to succeed, requests must conform to any transfer requirements of the underlying resource. Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets. This method doesn't support partial writing of metadata. - Parameters: - buffer: A buffer to provide the data. - offset: The offset into the resource from which to start writing. - length: The number of bytes to writing. - error: On return, any error encountered while writing data, or `nil` if no error occurred. - Returns: A Boolean value indicating whether the metadata write succeeded.
func (*FSBlockDeviceResource) PhysicalBlockSize ¶
func (o *FSBlockDeviceResource) PhysicalBlockSize() uint64
The sector size of the device. This is equivalent to the `DKIOCGETPHYSICALBLOCKSIZE` device parameter.
func (*FSBlockDeviceResource) ReadIntoStartingAtLengthCompletionHandler ¶
func (o *FSBlockDeviceResource) ReadIntoStartingAtLengthCompletionHandler(buffer unsafe.Pointer, offset int64, length uint, completionHandler func(uint, unsafe.Pointer))
Reads data from the resource into a buffer and executes a block afterwards. For the read to succeed, requests must conform to any transfer requirements of the underlying resource. Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets. - Parameters: - buffer: A buffer to receive the data. - offset: The offset into the resource from which to start reading. - length: A maximum number of bytes to read. The completion handler receives a parameter with the actual number of bytes read. - completionHandler: A block that executes after the read operation completes. If successful, the first parameter contains the number of bytes actually read. In the case of an error, the second parameter contains a non-`nil` error. This value is `EFAULT` if `buffer` is `NULL`, or `errno` if reading from the resource failed.
func (*FSBlockDeviceResource) ReadIntoStartingAtLengthError ¶
func (o *FSBlockDeviceResource) ReadIntoStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (uint, error)
Synchronously reads data from the resource into a buffer. This is a synchronous version of “readInto:startingAt:length:completionHandler:“. > Note: In some cases, this method performs a partial read. In this case, the return value is shorter than the requested length, and the `error` is set to `nil`. - Parameters: - buffer: A buffer to receive the data. - offset: The offset into the resource from which to start reading. - length: A maximum number of bytes to read. The method's return value contains the actual number of bytes read. - error: On return, any error encountered while reading data, or `nil` if no error occurred. - Returns: The actual number of bytes read.
func (*FSBlockDeviceResource) WriteFromStartingAtLengthCompletionHandler ¶
func (o *FSBlockDeviceResource) WriteFromStartingAtLengthCompletionHandler(buffer unsafe.Pointer, offset int64, length uint, completionHandler func(uint, unsafe.Pointer))
Writes data from from a buffer to the resource and executes a block afterwards. For the write to succeed, requests must conform to any transfer requirements of the underlying resource. Disk drives typically require sector (`physicalBlockSize`) addressed operations of one or more sector-aligned offsets. - Parameters: - buffer: A buffer to provide the data. - offset: The offset into the resource from which to start writing. - length: A maximum number of bytes to write. The completion handler receives a parameter with the actual number of bytes write. - completionHandler: A block that executes after the write operation completes. If successful, the first parameter contains the number of bytes actually written. In the case of an error, the second parameter contains a non-`nil` error. This value is `EFAULT` if `buffer` is `NULL`, or `errno` if writing to the resource failed.
func (*FSBlockDeviceResource) WriteFromStartingAtLengthError ¶
func (o *FSBlockDeviceResource) WriteFromStartingAtLengthError(buffer unsafe.Pointer, offset int64, length uint) (uint, error)
Synchronously writes data from from a buffer to the resource and executes a block afterwards. This is a synchronous version of “writeFrom:startingAt:length:completionHandler:“. > Note: In some cases, this method performs a partial write. In this case, the return value is shorter than the requested length, and the `error` is set to `nil`. - Parameters: - buffer: A buffer to provide the data. - offset: The offset into the resource from which to start writing. - length: A maximum number of bytes to write. The completion handler receives a parameter with the actual number of bytes write. - error: On return, any error encountered while writing data, or `nil` if no error occurred. - Returns: The actual number of bytes written.
type FSBlockmapFlags ¶
type FSBlockmapFlags uint64
const ( // A flag that describes a read operation. FSBlockmapFlagsRead FSBlockmapFlags = 256 // A flag that describes a write operation. FSBlockmapFlagsWrite FSBlockmapFlags = 512 )
func (FSBlockmapFlags) String ¶
func (e FSBlockmapFlags) String() string
type FSClient ¶
type FSClient struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsclient
func FSClientFromID ¶
func FSClientSharedInstance ¶
func FSClientSharedInstance() *FSClient
The shared instance of the FSKit client class.
func (*FSClient) FetchInstalledExtensionsWithCompletionHandler ¶
func (o *FSClient) FetchInstalledExtensionsWithCompletionHandler(completionHandler func(*foundation.NSArray[*FSModuleIdentity], unsafe.Pointer))
Asynchronously retrieves an list of installed file system modules. In Swift, you can either call this method and pass a completion handler closure, or get the value of the `installedExtensions` property with the `async` keyword. - Parameter completionHandler: A block or closure that executes when FSKit finishes its fetch process. If the fetch succeeds, the first parameter contains an array of “FSModuleIdentity“ instances that identify installed modules. If the fetch fails, the second parameter contains an error detailing the failure.
type FSCompleteIOFlags ¶
type FSCompleteIOFlags uint64
const ( // A flag that describes a read operation. FSCompleteIOFlagsRead FSCompleteIOFlags = 256 // A flag that describes a write operation. FSCompleteIOFlagsWrite FSCompleteIOFlags = 512 // A flag that requests that the file system module flush metadata I/O asynchronously. FSCompleteIOFlagsAsync FSCompleteIOFlags = 1024 )
func (FSCompleteIOFlags) String ¶
func (e FSCompleteIOFlags) String() string
type FSContainerIdentifier ¶
type FSContainerIdentifier struct {
FSEntityIdentifier
}
Apple documentation: https://developer.apple.com/documentation/fskit/fscontaineridentifier
func FSContainerIdentifierFromID ¶
func FSContainerIdentifierFromID(id objc.ID) *FSContainerIdentifier
func (*FSContainerIdentifier) VolumeIdentifier ¶
func (o *FSContainerIdentifier) VolumeIdentifier() *FSVolumeIdentifier
type FSContainerState ¶
type FSContainerState int64
const ( // The container isn't ready. FSContainerStateNotReady FSContainerState = 0 // The container is blocked from transitioning from the not-ready state to the ready state by a potentially-recoverable error. This state implies that the error has a resolution that would allow the container to become ready, such as correcting an incorrect password. FSContainerStateBlocked FSContainerState = 1 // The container is ready, but inactive. FSContainerStateReady FSContainerState = 2 // The container is active, and one or more volumes are active. FSContainerStateActive FSContainerState = 3 )
func (FSContainerState) String ¶
func (e FSContainerState) String() string
type FSContainerStatus ¶
type FSContainerStatus struct {
foundation.NSObject
}
A type that represents a container's status. This type contains two properties: * The “state“ value that indicates the state of the container, such as “FSContainerState/ready“ or “FSContainerState/blocked“. * The “status“ is an error (optional in Swift, nullable in Objective-C) that provides further information about the state, such as why the container is blocked. Examples of statuses that require intervention include errors that indicate the container isn't ready (POSIX `EAGAIN` or `ENOTCONN`), the container needs authentication (`ENEEDAUTH`), or that authentication failed (`EAUTH`). The status can also be an informative error, such as the FSKit error “FSError/Code/statusOperationInProgress“.
Apple documentation: https://developer.apple.com/documentation/fskit/fscontainerstatus
func FSContainerStatusActive ¶
func FSContainerStatusActive() *FSContainerStatus
A status that represents an active container with no error. This value is a “FSContainerStatus“ with a “state“ that is “active“, and has a “status“ that is `nil`.
func FSContainerStatusActiveWithStatus ¶
func FSContainerStatusActiveWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
Returns a active container status instance with the provided error status. - Parameter errorStatus: The error status, if any, for the new instance.
func FSContainerStatusBlockedWithStatus ¶
func FSContainerStatusBlockedWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
Returns a blocked container status instance with the provided error status. - Parameter errorStatus: The error status, if any, for the new instance.
func FSContainerStatusFromID ¶
func FSContainerStatusFromID(id objc.ID) *FSContainerStatus
func FSContainerStatusNotReadyWithStatus ¶
func FSContainerStatusNotReadyWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
Returns a not-ready container status instance with the provided error status. - Parameter errorStatus: The error status, if any, for the new instance.
func FSContainerStatusReady ¶
func FSContainerStatusReady() *FSContainerStatus
A status that represents a ready container with no error. This value is a “FSContainerStatus“ with a “state“ that is “ready“, and a “status“ that is `nil`.
func FSContainerStatusReadyWithStatus ¶
func FSContainerStatusReadyWithStatus(errorStatus unsafe.Pointer) *FSContainerStatus
Returns a ready container status instance with the provided error status. - Parameter errorStatus: The error status, if any, for the new instance.
func (*FSContainerStatus) State ¶
func (o *FSContainerStatus) State() FSContainerState
A value that represents the container state, such as ready, active, or blocked.
func (*FSContainerStatus) Status ¶
func (o *FSContainerStatus) Status() unsafe.Pointer
An optional error that provides further information about the state.
type FSDeactivateOptions ¶
type FSDeactivateOptions int64
const ( // An option to force deactivation. FSDeactivateOptionsForce FSDeactivateOptions = 1 )
func (FSDeactivateOptions) String ¶
func (e FSDeactivateOptions) String() string
type FSDirectoryEntryPacker ¶
type FSDirectoryEntryPacker struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsdirectoryentrypacker
func FSDirectoryEntryPackerFromID ¶
func FSDirectoryEntryPackerFromID(id objc.ID) *FSDirectoryEntryPacker
func (*FSDirectoryEntryPacker) PackEntryWithNameItemTypeItemIDNextCookieAttributes ¶
func (o *FSDirectoryEntryPacker) PackEntryWithNameItemTypeItemIDNextCookieAttributes(name *FSFileName, itemType FSItemType, itemID FSItemID, nextCookie uint64, attributes *FSItemAttributes) bool
Provides a directory entry during enumeration. You call this method in your implementation of “FSVolume/Operations/enumerateDirectory(_:startingAt:verifier:attributes:packer:replyHandler:)“, for each directory entry you want to provide to the enumeration. - Parameters: - name: The item's name. - itemType: The type of the item. - itemID: The item's identifier. Typically this is an inode number, or one of the constants defined by “FSItem/Identifier“ like “FSItem/Identifier/rootDirectory“. - nextCookie: A value to indicate the next entry in the directory to enumerate. FSKit passes this value as the `cookie` parameter on the next call to “FSVolume/Operations/enumerateDirectory(_:startingAt:verifier:attributes:packer:replyHandler:)“. Use whatever value is appropriate for your implementation; the value is opaque to FSKit. - attributes: The item's attributes. Pass `nil` if the enumeration call didn't request attributes. - Returns: `true` (Swift) or `YES` (Objective-C) if packing was successful and enumeration can continue with the next directory entry. If the value is `false` (Swift) or `NO` (Objective-C), stop enumerating. This result can happen when the entry is too big for the remaining space in the buffer.
type FSEntityIdentifier ¶
type FSEntityIdentifier struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsentityidentifier
func FSEntityIdentifierFromID ¶
func FSEntityIdentifierFromID(id objc.ID) *FSEntityIdentifier
func (*FSEntityIdentifier) Init ¶
func (o *FSEntityIdentifier) Init() *FSEntityIdentifier
Creates an entity identifier with a random UUID.
func (*FSEntityIdentifier) InitWithUUID ¶
func (o *FSEntityIdentifier) InitWithUUID(uuid *foundation.NSUUID) *FSEntityIdentifier
Creates an entity identifier with the given UUID. - Parameter uuid: The UUID to use for this identifier.
func (*FSEntityIdentifier) InitWithUUIDData ¶
func (o *FSEntityIdentifier) InitWithUUIDData(uuid *foundation.NSUUID, qualifierData *foundation.NSData) *FSEntityIdentifier
Creates an entity identifier with the given UUID and qualifier data. - Parameters: - uuid: The UUID to use for this identifier. - qualifierData: The data to distinguish entities that otherwise share the same UUID.
func (*FSEntityIdentifier) InitWithUUIDQualifier ¶
func (o *FSEntityIdentifier) InitWithUUIDQualifier(uuid *foundation.NSUUID, qualifier uint64) *FSEntityIdentifier
Creates an entity identifier with the given UUID and qualifier data as a 64-bit unsigned integer. - Parameters: - uuid: The UUID to use for this identifier. - qualifier: The data to distinguish entities that otherwise share the same UUID.
func (*FSEntityIdentifier) Qualifier ¶
func (o *FSEntityIdentifier) Qualifier() *foundation.NSData
An optional piece of data to distinguish entities that otherwise share the same UUID.
func (*FSEntityIdentifier) SetQualifier ¶
func (o *FSEntityIdentifier) SetQualifier(qualifier *foundation.NSData)
func (*FSEntityIdentifier) SetUuid ¶
func (o *FSEntityIdentifier) SetUuid(uuid *foundation.NSUUID)
func (*FSEntityIdentifier) Uuid ¶
func (o *FSEntityIdentifier) Uuid() *foundation.NSUUID
A UUID to uniquely identify this entity.
type FSErrorCode ¶
type FSErrorCode int64
const ( // The module failed to load. FSErrorModuleLoadFailed FSErrorCode = 4500 // FSKit didn't recognize the resource, and probing failed to find a match. FSErrorResourceUnrecognized FSErrorCode = 4501 // The resource is damaged. This error indicates the resource needs a repair operation, or that a repair operation failed. > Note: The status in this error applies to the resource. A failing repair operation reports a more specific error status. FSErrorResourceDamaged FSErrorCode = 4502 // FSKit recognizes the resource, but the resource isn't usable. For example, this error occurs when a resource uses a file system's internal feature flags. If the only modules that support the file system don't support those feature flags, this code indicates an unusable resource. The error tells the person using the module why the resource isn't usable. FSErrorResourceUnusable FSErrorCode = 4503 // An operation is in progress. FSErrorStatusOperationInProgress FSErrorCode = 4504 // An operation is paused. FSErrorStatusOperationPaused FSErrorCode = 4505 // While enumerating a directory, the given cookie didn't resolve to a valid directory entry. FSErrorInvalidDirectoryCookie FSErrorCode = 4506 )
func (FSErrorCode) String ¶
func (e FSErrorCode) String() string
type FSExtentPacker ¶
type FSExtentPacker struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsextentpacker
func FSExtentPackerFromID ¶
func FSExtentPackerFromID(id objc.ID) *FSExtentPacker
func (*FSExtentPacker) PackExtentWithResourceTypeLogicalOffsetPhysicalOffsetLength ¶
func (o *FSExtentPacker) PackExtentWithResourceTypeLogicalOffsetPhysicalOffsetLength(resource *FSBlockDeviceResource, type_ FSExtentType, logicalOffset int64, physicalOffset int64, length uint) bool
Packs a single extent to send to the kernel. - Parameters: - resource: The resource on which to perform I/O. - type: The type of extent, indicating whether it contains valid data. - logicalOffset: The extent offset within the file, in bytes. - physicalOffset: The extent offset on disk, in bytes. - length: The extent length, in bytes. - Returns: A Boolean value that indicates whether the packer can pack more extents.
type FSExtentType ¶
type FSExtentType int64
const ( // An extent type to indicate valid data. Use this type for all extents on a file system that doesn't support sparse files. > Tip: The kernel keeps track of the end of file, so it knows a range of `[EOF, allocated space]` is uninitialized. Because of this behavior, it's valid to pass the data extent type for such a range. FSExtentTypeData FSExtentType = 0 // An extent type to indicate uninitialized data. Only use this extent type in file systems that support sparse files, and only then to represent ranges in the file that aren't allocated yet. FSExtentTypeZeroFill FSExtentType = 1 )
func (FSExtentType) String ¶
func (e FSExtentType) String() string
type FSFileName ¶
type FSFileName struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsfilename
func FSFileNameFromID ¶
func FSFileNameFromID(id objc.ID) *FSFileName
func FSFileNameNameWithBytesLength ¶
func FSFileNameNameWithBytesLength(bytes_ string, length uint) *FSFileName
Creates a filename by copying a character sequence from a byte array. - Parameters: - bytes: A pointer to the character data to copy, up to a maximum of `length`. The sequence terminates if a `NUL` character exists prior to `length`. - length: The size of the `bytes` array.
func FSFileNameNameWithCString ¶
func FSFileNameNameWithCString(name string) *FSFileName
Creates a filename from a null-terminated character sequence. - Parameter name: A pointer to a C string.
func FSFileNameNameWithData ¶
func FSFileNameNameWithData(name *foundation.NSData) *FSFileName
Creates a filename by copying a character sequence data object. This initializer copies up to `name.length` characters of the sequence pointed to by `bytes`. - Parameter name: The data object containing the character sequence to use for the filename. The sequence terminates if a `NUL` character exists prior to `name.length`.
func FSFileNameNameWithString ¶
func FSFileNameNameWithString(name *foundation.NSString) *FSFileName
Creates a filename by copying a character sequence from a string instance. This initializer copies the UTF-8 representation of the characters in `string`. If `string` contains a `NUL` character, the sequence terminates. - Parameter name: The string containing the character sequence to use for the filename.
func (*FSFileName) Data ¶
func (o *FSFileName) Data() *foundation.NSData
The byte sequence of the filename, as a data object. This property always provides a value.
func (*FSFileName) InitWithBytesLength ¶
func (o *FSFileName) InitWithBytesLength(bytes_ string, length uint) *FSFileName
Initializes a file name by copying a character sequence from a byte array. > Note: This initializer is unavailable in Swift. Use “initWithData:“ or “initWithString:“ instead. - Parameters: - bytes: A pointer to the character data to copy, up to a maximum of `length`. The sequence terminates if a `NUL` character exists prior to `length`. - length: The size of the `bytes` array.
func (*FSFileName) InitWithCString ¶
func (o *FSFileName) InitWithCString(name string) *FSFileName
Initializes a filename from a null-terminated character sequence. > Note: This initializer is unavailable in Swift. Use “initWithData:“ or “initWithString:“ instead. - Parameter name: A pointer to a C string.
func (*FSFileName) InitWithData ¶
func (o *FSFileName) InitWithData(name *foundation.NSData) *FSFileName
Creates a filename by copying a character sequence data object. This initializer copies up to `name.length` characters of the sequence pointed to by `bytes`. - Parameter name: The data object containing the character sequence to use for the filename. The sequence terminates if a `NUL` character exists prior to `name.length`.
func (*FSFileName) InitWithString ¶
func (o *FSFileName) InitWithString(name *foundation.NSString) *FSFileName
Creates a filename by copying a character sequence from a string instance. This initializer copies the UTF-8 representation of the characters in `string`. If `string` contains a `NUL` character, the sequence terminates. - Parameter name: The string containing the character sequence to use for the filename.
func (*FSFileName) String ¶
func (o *FSFileName) String() *foundation.NSString
The filename, represented as a Unicode string. If the value of the filename's “FSFileName/data“ is not a valid UTF-8 byte sequence, this property is empty.
type FSFileSystem ¶
type FSFileSystem struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsfilesystem
func FSFileSystemFromID ¶
func FSFileSystemFromID(id objc.ID) *FSFileSystem
type FSFileSystemBase ¶
type FSFileSystemBase interface {
WipeResourceCompletionHandler(resource *FSBlockDeviceResource, completion func(unsafe.Pointer))
ContainerStatus() *FSContainerStatus
SetContainerStatus(containerStatus *FSContainerStatus)
}
FSFileSystemBase wraps the ObjC protocol FSFileSystemBase.
type FSGenericURLResource ¶
type FSGenericURLResource struct {
FSResource
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsgenericurlresource
func FSGenericURLResourceFromID ¶
func FSGenericURLResourceFromID(id objc.ID) *FSGenericURLResource
func (*FSGenericURLResource) InitWithURL ¶
func (o *FSGenericURLResource) InitWithURL(url *foundation.NSURL) *FSGenericURLResource
Creates a generic URL resource with the given URL. - Parameter url: A URL that provides the content of the file system. The format of this URL is completely arbitrary. It's up to your extension to access the contents represented by the URL and make them available as an “FSVolume“ that FSKit can load.
func (*FSGenericURLResource) Url ¶
func (o *FSGenericURLResource) Url() *foundation.NSURL
The URL represented by the resource.
type FSItem ¶
type FSItem struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsitem
func FSItemFromID ¶
type FSItemAttribute ¶
type FSItemAttribute int64
const ( // The type attribute. FSItemAttributeType FSItemAttribute = 1 // The mode attribute. FSItemAttributeMode FSItemAttribute = 2 // The link count attribute. FSItemAttributeLinkCount FSItemAttribute = 4 // The user ID (uid) attribute. FSItemAttributeUID FSItemAttribute = 8 // The group ID (gid) attribute. FSItemAttributeGID FSItemAttribute = 16 // The flags attribute. FSItemAttributeFlags FSItemAttribute = 32 // The size attribute. FSItemAttributeSize FSItemAttribute = 64 // The allocated size attribute. FSItemAttributeAllocSize FSItemAttribute = 128 // The file ID attribute. FSItemAttributeFileID FSItemAttribute = 256 // The parent ID attribute. FSItemAttributeParentID FSItemAttribute = 512 // The last-accessed time attribute. FSItemAttributeAccessTime FSItemAttribute = 1024 // The last-modified time attribute. FSItemAttributeModifyTime FSItemAttribute = 2048 // The last-changed time attribute. FSItemAttributeChangeTime FSItemAttribute = 4096 // The creation time attribute. FSItemAttributeBirthTime FSItemAttribute = 8192 // The backup time attribute. FSItemAttributeBackupTime FSItemAttribute = 16384 // The time added attribute. FSItemAttributeAddedTime FSItemAttribute = 32768 // The supports limited extended attributes attribute. FSItemAttributeSupportsLimitedXAttrs FSItemAttribute = 65536 // The inhibit kernel offloaded I/O attribute. FSItemAttributeInhibitKernelOffloadedIO FSItemAttribute = 131072 )
func (FSItemAttribute) String ¶
func (e FSItemAttribute) String() string
type FSItemAttributes ¶
type FSItemAttributes struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsitemattributes
func FSItemAttributesFromID ¶
func FSItemAttributesFromID(id objc.ID) *FSItemAttributes
func (*FSItemAttributes) AccessTime ¶
func (o *FSItemAttributes) AccessTime() unsafe.Pointer
The item's last-accessed time.
func (*FSItemAttributes) AddedTime ¶
func (o *FSItemAttributes) AddedTime() unsafe.Pointer
The item's added time. This property represents the time the file system added the item to its parent directory.
func (*FSItemAttributes) AllocSize ¶
func (o *FSItemAttributes) AllocSize() uint64
The item's allocated size.
func (*FSItemAttributes) BackupTime ¶
func (o *FSItemAttributes) BackupTime() unsafe.Pointer
The item's last-backup time.
func (*FSItemAttributes) BirthTime ¶
func (o *FSItemAttributes) BirthTime() unsafe.Pointer
The item's creation time.
func (*FSItemAttributes) ChangeTime ¶
func (o *FSItemAttributes) ChangeTime() unsafe.Pointer
The item's last-changed time. This property represents `ctime`, the last time the item's metadata changed.
func (*FSItemAttributes) FileID ¶
func (o *FSItemAttributes) FileID() FSItemID
The item's file identifier.
func (*FSItemAttributes) Flags ¶
func (o *FSItemAttributes) Flags() uint32
The item's behavior flags. See `st_flags` in `stat.h` for flag definitions.
func (*FSItemAttributes) InhibitKernelOffloadedIO ¶
func (o *FSItemAttributes) InhibitKernelOffloadedIO() bool
A Boolean value that indicates whether the file system overrides the per-volume settings for kernel offloaded I/O for a specific file. This property has no meaning if the volume doesn't conform to “FSVolumeKernelOffloadedIOOperations“.
func (*FSItemAttributes) InvalidateAllProperties ¶
func (o *FSItemAttributes) InvalidateAllProperties()
Marks all attributes inactive.
func (*FSItemAttributes) IsValid ¶
func (o *FSItemAttributes) IsValid(attribute FSItemAttribute) bool
Returns a Boolean value that indicates whether the attribute is valid. If the value returned by this method is `YES` (Objective-C) or `true` (Swift), a caller can safely use the given attribute.
func (*FSItemAttributes) LinkCount ¶
func (o *FSItemAttributes) LinkCount() uint32
The number of hard links to the item.
func (*FSItemAttributes) Mode ¶
func (o *FSItemAttributes) Mode() uint32
The mode of the item. The mode is often used for `setuid`, `setgid`, and `sticky` bits.
func (*FSItemAttributes) ModifyTime ¶
func (o *FSItemAttributes) ModifyTime() unsafe.Pointer
The item's last-modified time. This property represents `mtime`, the last time the item's contents changed.
func (*FSItemAttributes) ParentID ¶
func (o *FSItemAttributes) ParentID() FSItemID
The identifier of the item's parent.
func (*FSItemAttributes) SetAccessTime ¶
func (o *FSItemAttributes) SetAccessTime(accessTime unsafe.Pointer)
func (*FSItemAttributes) SetAddedTime ¶
func (o *FSItemAttributes) SetAddedTime(addedTime unsafe.Pointer)
func (*FSItemAttributes) SetAllocSize ¶
func (o *FSItemAttributes) SetAllocSize(allocSize uint64)
func (*FSItemAttributes) SetBackupTime ¶
func (o *FSItemAttributes) SetBackupTime(backupTime unsafe.Pointer)
func (*FSItemAttributes) SetBirthTime ¶
func (o *FSItemAttributes) SetBirthTime(birthTime unsafe.Pointer)
func (*FSItemAttributes) SetChangeTime ¶
func (o *FSItemAttributes) SetChangeTime(changeTime unsafe.Pointer)
func (*FSItemAttributes) SetFileID ¶
func (o *FSItemAttributes) SetFileID(fileID FSItemID)
func (*FSItemAttributes) SetFlags ¶
func (o *FSItemAttributes) SetFlags(flags uint32)
func (*FSItemAttributes) SetGid ¶
func (o *FSItemAttributes) SetGid(gid uint32)
func (*FSItemAttributes) SetInhibitKernelOffloadedIO ¶
func (o *FSItemAttributes) SetInhibitKernelOffloadedIO(inhibitKernelOffloadedIO bool)
func (*FSItemAttributes) SetLinkCount ¶
func (o *FSItemAttributes) SetLinkCount(linkCount uint32)
func (*FSItemAttributes) SetMode ¶
func (o *FSItemAttributes) SetMode(mode uint32)
func (*FSItemAttributes) SetModifyTime ¶
func (o *FSItemAttributes) SetModifyTime(modifyTime unsafe.Pointer)
func (*FSItemAttributes) SetParentID ¶
func (o *FSItemAttributes) SetParentID(parentID FSItemID)
func (*FSItemAttributes) SetSize ¶
func (o *FSItemAttributes) SetSize(size uint64)
func (*FSItemAttributes) SetSupportsLimitedXAttrs ¶
func (o *FSItemAttributes) SetSupportsLimitedXAttrs(supportsLimitedXAttrs bool)
func (*FSItemAttributes) SetType ¶
func (o *FSItemAttributes) SetType(type_ FSItemType)
func (*FSItemAttributes) SetUid ¶
func (o *FSItemAttributes) SetUid(uid uint32)
func (*FSItemAttributes) SupportsLimitedXAttrs ¶
func (o *FSItemAttributes) SupportsLimitedXAttrs() bool
A Boolean value that indicates whether the item supports a limited set of extended attributes.
func (*FSItemAttributes) Type ¶
func (o *FSItemAttributes) Type() FSItemType
The item type, such as a regular file, directory, or symbolic link.
type FSItemDeactivationOptions ¶
type FSItemDeactivationOptions uint64
const ( // An option to never perform deactivation. With this deactivation option, FSKit never issues `deactivateItem` calls, even though the volume conforms to “FSVolume/ItemDeactivation“. FSItemDeactivationNever FSItemDeactivationOptions = 0 // An option to always perform deactivation calls. Use this option if the file system needs `deactivateItem` calls in circumstances beyond those covered by “forRemovedItems“ and “forPreallocatedItems“. FSItemDeactivationAlways FSItemDeactivationOptions = 18446744073709551615 // An option to process deactivation for open-unlinked items at the moment of last close. FSItemDeactivationForRemovedItems FSItemDeactivationOptions = 1 // An option to process deactivation for for files with preallocated space. This option facilitates a sort of trim-on-close behavior. It is only meaningful for volumes that conform to “FSVolume/PreallocateOperations“. FSItemDeactivationForPreallocatedItems FSItemDeactivationOptions = 2 )
func (FSItemDeactivationOptions) String ¶
func (e FSItemDeactivationOptions) String() string
type FSItemGetAttributesRequest ¶
type FSItemGetAttributesRequest struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsitemgetattributesrequest
func FSItemGetAttributesRequestFromID ¶
func FSItemGetAttributesRequestFromID(id objc.ID) *FSItemGetAttributesRequest
func (*FSItemGetAttributesRequest) IsAttributeWanted ¶
func (o *FSItemGetAttributesRequest) IsAttributeWanted(attribute FSItemAttribute) bool
A method that indicates whether the request wants given attribute. - Parameter attribute: The “FSItemAttribute“ to check.
func (*FSItemGetAttributesRequest) SetWantedAttributes ¶
func (o *FSItemGetAttributesRequest) SetWantedAttributes(wantedAttributes FSItemAttribute)
func (*FSItemGetAttributesRequest) WantedAttributes ¶
func (o *FSItemGetAttributesRequest) WantedAttributes() FSItemAttribute
The attributes requested by the request. This property is a bit field in Objective-C and an <doc://com.apple.documentation/documentation/Swift/OptionSet> in Swift.
type FSItemSetAttributesRequest ¶
type FSItemSetAttributesRequest struct {
FSItemAttributes
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsitemsetattributesrequest
func FSItemSetAttributesRequestFromID ¶
func FSItemSetAttributesRequestFromID(id objc.ID) *FSItemSetAttributesRequest
func (*FSItemSetAttributesRequest) ConsumedAttributes ¶
func (o *FSItemSetAttributesRequest) ConsumedAttributes() FSItemAttribute
The attributes successfully used by the file system. This property is a bit field in Objective-C and an <doc://com.apple.documentation/documentation/Swift/OptionSet> in Swift.
func (*FSItemSetAttributesRequest) SetConsumedAttributes ¶
func (o *FSItemSetAttributesRequest) SetConsumedAttributes(consumedAttributes FSItemAttribute)
func (*FSItemSetAttributesRequest) WasAttributeConsumed ¶
func (o *FSItemSetAttributesRequest) WasAttributeConsumed(attribute FSItemAttribute) bool
A method that indicates whether the file system used the given attribute. - Parameter attribute: The “FSItemAttribute“ to check.
type FSItemType ¶
type FSItemType int64
const ( // The item type of an unknown item. FSItemTypeUnknown FSItemType = 0 // The item type of a regular file. FSItemTypeFile FSItemType = 1 // The item type of a directory. FSItemTypeDirectory FSItemType = 2 // The item type of a symbolic link. FSItemTypeSymlink FSItemType = 3 // The item type of a first-in/first-out named pipe. FSItemTypeFIFO FSItemType = 4 // The item type of a character device. FSItemTypeCharDevice FSItemType = 5 // The item type of a block device. FSItemTypeBlockDevice FSItemType = 6 // The item type of a socket. FSItemTypeSocket FSItemType = 7 )
func (FSItemType) String ¶
func (e FSItemType) String() string
type FSManageableResourceMaintenanceOperations ¶
type FSManageableResourceMaintenanceOperations interface {
StartCheckWithTaskOptionsError(task *FSTask, options *FSTaskOptions) (*foundation.NSProgress, error)
StartFormatWithTaskOptionsError(task *FSTask, options *FSTaskOptions) (*foundation.NSProgress, error)
}
FSManageableResourceMaintenanceOperations wraps the ObjC protocol FSManageableResourceMaintenanceOperations.
type FSMatchResult ¶
type FSMatchResult int64
const ( // The probe doesn't recognize the resource. This match result is appropriate when the file system module determines that the resource uses a completely different format. FSMatchResultNotRecognized FSMatchResult = 0 // The probe recognizes the resource but can't use it. This match result is appropriate when the file system module identifies the resource's format but can't use it. For example, if the resource uses a newer version than the module supports, the module can name the resource but can't safely do anything with it. FSMatchResultRecognized FSMatchResult = 1 // The probe recognizes the resource and is ready to use it, but only in a limited capacity. This match result is appropriate when the file system module identifies the resource's format but also identifies incompatibilities. For example, if the module determines the resource uses new features that the module doesn't support, the module may only offer read-only access. FSMatchResultUsableButLimited FSMatchResult = 2 // The probe recognizes the resource and is ready to use it. FSMatchResultUsable FSMatchResult = 3 )
func (FSMatchResult) String ¶
func (e FSMatchResult) String() string
type FSMetadataRange ¶
type FSMetadataRange struct {
foundation.NSObject
}
A range that describes contiguous metadata segments on disk. This type represents a range that begins at `startOffset` and ends at `startOffset + segmentLength * segmentCount`. Each segment in the range represents a single block in the resource's buffer cache. For example, given an `FSMetadataRange` with the following properties: * `startOffset = 0` * `segmentLength = 512` * `segmentCount = 8` The range represents eight segments: from 0 to 511, then from 512 to 1023, and so on until a final segment of 3584 to 4095. Ensure that each metadata segment represents a range that's already present in the resource's buffer cache. Similarly, ensure that each segment's offset and length matches the offset and length of the corresponding block in the buffer cache.
Apple documentation: https://developer.apple.com/documentation/fskit/fsmetadatarange
func FSMetadataRangeFromID ¶
func FSMetadataRangeFromID(id objc.ID) *FSMetadataRange
func FSMetadataRangeRangeWithOffsetSegmentLengthSegmentCount ¶
func FSMetadataRangeRangeWithOffsetSegmentLengthSegmentCount(startOffset int64, segmentLength uint64, segmentCount uint64) *FSMetadataRange
Creates a metadata range with the given properties. - Parameters: - startOffset: The start offset of the range in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“. - segmentLength: The segment length in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“. - segmentCount: The number of segments in the range.
func (*FSMetadataRange) InitWithOffsetSegmentLengthSegmentCount ¶
func (o *FSMetadataRange) InitWithOffsetSegmentLengthSegmentCount(startOffset int64, segmentLength uint64, segmentCount uint64) *FSMetadataRange
Initializes a metadata range with the given properties. - Parameters: - startOffset: The start offset of the range in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“. - segmentLength: The segment length in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“. - segmentCount: The number of segments in the range.
func (*FSMetadataRange) SegmentCount ¶
func (o *FSMetadataRange) SegmentCount() uint64
The number of segments in the range.
func (*FSMetadataRange) SegmentLength ¶
func (o *FSMetadataRange) SegmentLength() uint64
The segment length in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“.
func (*FSMetadataRange) StartOffset ¶
func (o *FSMetadataRange) StartOffset() int64
The start offset of the range in bytes. Ensure this value is a multiple of the corresponding resource's “FSBlockDeviceResource-c.class/blockSize“.
type FSModuleIdentity ¶
type FSModuleIdentity struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsmoduleidentity
func FSModuleIdentityFromID ¶
func FSModuleIdentityFromID(id objc.ID) *FSModuleIdentity
func (*FSModuleIdentity) BundleIdentifier ¶
func (o *FSModuleIdentity) BundleIdentifier() *foundation.NSString
The module's bundle identifier.
func (*FSModuleIdentity) IsEnabled ¶
func (o *FSModuleIdentity) IsEnabled() bool
type FSMountOptions ¶
type FSMountOptions uint64
const ( // An option to request a read-only mount. FSMountOptionsReadOnly FSMountOptions = 1 )
func (FSMountOptions) String ¶
func (e FSMountOptions) String() string
type FSMutableFileDataBuffer ¶
type FSMutableFileDataBuffer struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsmutablefiledatabuffer
func FSMutableFileDataBufferFromID ¶
func FSMutableFileDataBufferFromID(id objc.ID) *FSMutableFileDataBuffer
func (*FSMutableFileDataBuffer) Length ¶
func (o *FSMutableFileDataBuffer) Length() uint
The data length of the buffer.
func (*FSMutableFileDataBuffer) MutableBytes ¶
func (o *FSMutableFileDataBuffer) MutableBytes() unsafe.Pointer
The byte data.
type FSPathURLResource ¶
type FSPathURLResource struct {
FSResource
}
Apple documentation: https://developer.apple.com/documentation/fskit/fspathurlresource
func FSPathURLResourceFromID ¶
func FSPathURLResourceFromID(id objc.ID) *FSPathURLResource
func (*FSPathURLResource) InitWithURLWritable ¶
func (o *FSPathURLResource) InitWithURLWritable(uRL *foundation.NSURL, writable bool) *FSPathURLResource
Creates a path URL resource. - Parameters: - URL: A URL in the system file space that represents the contents of a file system. This parameter uses the `file:` scheme. - writable: A Boolean value that indicates whether the file system supports writing to the contents of the URL.
func (*FSPathURLResource) IsWritable ¶
func (o *FSPathURLResource) IsWritable() bool
func (*FSPathURLResource) Url ¶
func (o *FSPathURLResource) Url() *foundation.NSURL
The URL represented by the resource.
type FSPreallocateFlags ¶
type FSPreallocateFlags uint64
const ( // Allocates contiguous space. FSPreallocateFlagsContiguous FSPreallocateFlags = 2 // Allocates all requested space or no space at all. FSPreallocateFlagsAll FSPreallocateFlags = 4 // Allocates space that isn't freed when deleting the descriptor. This space remains allocated even after calling `close(2)`. FSPreallocateFlagsPersist FSPreallocateFlags = 8 // Allocates space from the physical end of file. When implementing this behavior, ignore any offset in the preallocate call. This flag is currently set for all “FSVolume/PreallocateOperations/preallocateSpace(for:at:length:flags:replyHandler:)“ calls. FSPreallocateFlagsFromEOF FSPreallocateFlags = 16 )
func (FSPreallocateFlags) String ¶
func (e FSPreallocateFlags) String() string
type FSProbeResult ¶
type FSProbeResult struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsproberesult
func FSProbeResultFromID ¶
func FSProbeResultFromID(id objc.ID) *FSProbeResult
func FSProbeResultNotRecognizedProbeResult ¶
func FSProbeResultNotRecognizedProbeResult() *FSProbeResult
A probe result for an unrecognized file system. An unrecognized probe result contains `nil` for its “FSProbeResult/name“ and “FSProbeResult/containerID“ properties.
func FSProbeResultRecognizedProbeResultWithNameContainerID ¶
func FSProbeResultRecognizedProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
Creates a probe result for a recognized file system. - Parameters: - name: The resource name, as found during the probe operation. If the file system doesn't support names, or is awaiting naming, use an empty string. - containerID: The container identifier, as found during the probe operation. If the file system doesn't support durable identifiers, use a random UUID.
func FSProbeResultUsableButLimitedProbeResult ¶
func FSProbeResultUsableButLimitedProbeResult() *FSProbeResult
A probe result for a recognized file system that is usable, but with limited capabilities. This kind of probe result lacks the “FSProbeResult/name“, “FSProbeResult/containerID“, or both. Don't return this result from probing a resource that isn't limited.
func FSProbeResultUsableButLimitedProbeResultWithNameContainerID ¶
func FSProbeResultUsableButLimitedProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
Creates a probe result for a recognized file system that is usable, but with limited capabilities. - Parameters: - name: The resource name, as found during the probe operation. If the file system doesn't support names, or is awaiting naming, use an empty string. - containerID: The container identifier, as found during the probe operation. If the file system doesn't support durable identifiers, use a random UUID.
func FSProbeResultUsableProbeResultWithNameContainerID ¶
func FSProbeResultUsableProbeResultWithNameContainerID(name *foundation.NSString, containerID *FSContainerIdentifier) *FSProbeResult
Creates a probe result for a recognized and usable file system. - Parameters: - name: The resource name, as found during the probe operation. If the file system doesn't support names, or is awaiting naming, use an empty string. - containerID: The container identifier, as found during the probe operation. If the file system doesn't support durable identifiers, use a random UUID.
func (*FSProbeResult) ContainerID ¶
func (o *FSProbeResult) ContainerID() *FSContainerIdentifier
The container identifier, as found during the probe operation. This value is non-`nil` unless the “FSProbeResult/result“ is “FSMatchResult/notRecognized“. For formats that lack a durable UUID on which to base a container identifier --- which is only legal for a “FSUnaryFileSystem“ --- this value may be a random UUID.
func (*FSProbeResult) Name ¶
func (o *FSProbeResult) Name() *foundation.NSString
The resource name, as found during the probe operation. This value is non-`nil` unless the “FSProbeResult/result“ is “FSMatchResult/notRecognized`. For formats that lack a name, this value may be an empty string. This value can also be an empty string if the format supports a name, but the value isn't set yet.
func (*FSProbeResult) Result ¶
func (o *FSProbeResult) Result() FSMatchResult
The match result, representing the recognition and usability of a probed resource.
type FSResource ¶
type FSResource struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsresource
func FSResourceFromID ¶
func FSResourceFromID(id objc.ID) *FSResource
func (*FSResource) IsRevoked ¶
func (o *FSResource) IsRevoked() bool
A Boolean value that indicates whether the resource is revoked. If this is a proxy resource, the value of this property is always `true` (Swift) or `YES` (Objective-C).
func (*FSResource) MakeProxy ¶
func (o *FSResource) MakeProxy() *FSResource
Creates a proxy object of this resource. If you create a proxy from a proxy resource, this method returns a copy of the proxy.
func (*FSResource) Revoke ¶
func (o *FSResource) Revoke()
Revokes the resource. This method works by stripping away any underlying privileges associated with the resource. This effectively disconnects this object from its underlying resource.
type FSSetXattrPolicy ¶
type FSSetXattrPolicy uint64
const ( // Set the value, regardless of previous state. FSSetXattrPolicyAlwaysSet FSSetXattrPolicy = 0 // Set the value, but fail if the extended attribute already exists. FSSetXattrPolicyMustCreate FSSetXattrPolicy = 1 // Set the value, but fail if the extended attribute doesn't already exist. FSSetXattrPolicyMustReplace FSSetXattrPolicy = 2 // Delete the value, failing if the extended attribute doesn't exist. FSSetXattrPolicyDelete FSSetXattrPolicy = 3 )
func (FSSetXattrPolicy) String ¶
func (e FSSetXattrPolicy) String() string
type FSStatFSResult ¶
type FSStatFSResult struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsstatfsresult
func FSStatFSResultFromID ¶
func FSStatFSResultFromID(id objc.ID) *FSStatFSResult
func (*FSStatFSResult) AvailableBlocks ¶
func (o *FSStatFSResult) AvailableBlocks() uint64
A property for the number of free blocks available to a non-superuser on the volume.
func (*FSStatFSResult) AvailableBytes ¶
func (o *FSStatFSResult) AvailableBytes() uint64
A property for the amount of space available to users, in bytes, in the volume.
func (*FSStatFSResult) BlockSize ¶
func (o *FSStatFSResult) BlockSize() int
A property for the volume's block size, in bytes. This value defaults to `4096`. Zero isn't a valid block size.
func (*FSStatFSResult) FileSystemSubType ¶
func (o *FSStatFSResult) FileSystemSubType() int
A property for the file system's subtype or flavor. Match this value to the `FSPersonalities`'s `FSSubType` attribute, if it exists within the `EXAppExtensionAttributes` dictionary of the module's `Info.plist`.
func (*FSStatFSResult) FileSystemTypeName ¶
func (o *FSStatFSResult) FileSystemTypeName() *foundation.NSString
A property for the file system type name. Match this value to the `FSShortName` attribute within the `EXAppExtensionAttributes` dictionary of the module's `Info.plist`. The maximum allowed length is `MFSTYPENAMELEN`, including the terminating `NUL` character.
func (*FSStatFSResult) FreeBlocks ¶
func (o *FSStatFSResult) FreeBlocks() uint64
A property for the number of free blocks in the volume.
func (*FSStatFSResult) FreeBytes ¶
func (o *FSStatFSResult) FreeBytes() uint64
A property for the amount of free space, in bytes, in the volume.
func (*FSStatFSResult) FreeFiles ¶
func (o *FSStatFSResult) FreeFiles() uint64
A property for the total number of free file slots in the volume.
func (*FSStatFSResult) InitWithFileSystemTypeName ¶
func (o *FSStatFSResult) InitWithFileSystemTypeName(fileSystemTypeName *foundation.NSString) *FSStatFSResult
Creates an statistics result instance, using the given file system type name. - Parameters fileSystemTypeName: A type name for the file system. The maximum allowed length is `MFSTYPENAMELEN`, including the terminating `NUL` character.
func (*FSStatFSResult) IoSize ¶
func (o *FSStatFSResult) IoSize() int
A property for the optimal block size with which to perform I/O. For best performance, specify an `ioSize` that's an even multiple of “blockSize“.
func (*FSStatFSResult) SetAvailableBlocks ¶
func (o *FSStatFSResult) SetAvailableBlocks(availableBlocks uint64)
func (*FSStatFSResult) SetAvailableBytes ¶
func (o *FSStatFSResult) SetAvailableBytes(availableBytes uint64)
func (*FSStatFSResult) SetBlockSize ¶
func (o *FSStatFSResult) SetBlockSize(blockSize int)
func (*FSStatFSResult) SetFileSystemSubType ¶
func (o *FSStatFSResult) SetFileSystemSubType(fileSystemSubType int)
func (*FSStatFSResult) SetFreeBlocks ¶
func (o *FSStatFSResult) SetFreeBlocks(freeBlocks uint64)
func (*FSStatFSResult) SetFreeBytes ¶
func (o *FSStatFSResult) SetFreeBytes(freeBytes uint64)
func (*FSStatFSResult) SetFreeFiles ¶
func (o *FSStatFSResult) SetFreeFiles(freeFiles uint64)
func (*FSStatFSResult) SetIoSize ¶
func (o *FSStatFSResult) SetIoSize(ioSize int)
func (*FSStatFSResult) SetTotalBlocks ¶
func (o *FSStatFSResult) SetTotalBlocks(totalBlocks uint64)
func (*FSStatFSResult) SetTotalBytes ¶
func (o *FSStatFSResult) SetTotalBytes(totalBytes uint64)
func (*FSStatFSResult) SetTotalFiles ¶
func (o *FSStatFSResult) SetTotalFiles(totalFiles uint64)
func (*FSStatFSResult) SetUsedBlocks ¶
func (o *FSStatFSResult) SetUsedBlocks(usedBlocks uint64)
func (*FSStatFSResult) SetUsedBytes ¶
func (o *FSStatFSResult) SetUsedBytes(usedBytes uint64)
func (*FSStatFSResult) TotalBlocks ¶
func (o *FSStatFSResult) TotalBlocks() uint64
A property for the volume's total data block count.
func (*FSStatFSResult) TotalBytes ¶
func (o *FSStatFSResult) TotalBytes() uint64
A property for the total size, in bytes, of the volume.
func (*FSStatFSResult) TotalFiles ¶
func (o *FSStatFSResult) TotalFiles() uint64
A property for the total number of file slots in the volume,
func (*FSStatFSResult) UsedBlocks ¶
func (o *FSStatFSResult) UsedBlocks() uint64
A property for the number of used blocks in the volume.
func (*FSStatFSResult) UsedBytes ¶
func (o *FSStatFSResult) UsedBytes() uint64
A property for the amount of used space, in bytes, in the volume.
type FSSyncFlags ¶
type FSSyncFlags int64
const ( // A flag for synchronized I/O with file-integrity completion. FSSyncFlagsWait FSSyncFlags = 1 // A flag for synchronized I/O that starts I/O but doesn't wait for it. FSSyncFlagsNoWait FSSyncFlags = 2 // A flag for synchronized I/O with data-integrity completion. FSSyncFlagsDWait FSSyncFlags = 4 )
func (FSSyncFlags) String ¶
func (e FSSyncFlags) String() string
type FSTask ¶
type FSTask struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fstask
func FSTaskFromID ¶
func (*FSTask) CancellationHandler ¶
func (*FSTask) DidCompleteWithError ¶
Informs the client that the task completed. - Parameter error: `nil` if the task completed successfully; otherwise, an error that caused the task to fail.
func (*FSTask) LogMessage ¶
func (o *FSTask) LogMessage(str *foundation.NSString)
Logs the given string to the initiating client. - Parameter str: The string to log.
func (*FSTask) SetCancellationHandler ¶
type FSTaskOptions ¶
type FSTaskOptions struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fstaskoptions
func FSTaskOptionsFromID ¶
func FSTaskOptionsFromID(id objc.ID) *FSTaskOptions
func (*FSTaskOptions) TaskOptions ¶
func (o *FSTaskOptions) TaskOptions() *foundation.NSArray[*foundation.NSString]
An array of strings that represent command-line options for the task. This property is equivalent to the `argv` array of C strings passed to a command-line tool.
func (*FSTaskOptions) UrlForOption ¶
func (o *FSTaskOptions) UrlForOption(option *foundation.NSString) *foundation.NSURL
Retrieves a URL for a given option. Some command-line options refer to paths that indicate a location in which the module needs access to a file outside of its container. FSKit passes these paths as a URL tagged by the option name. For example, `"-B" "./someFile"` returns the URL for `./someFile` when passed an option `"B"`. To indicate that your module treats a given option as a path, include it in the `pathOptions` dictionary within a command options dictionary (`FSActivatOptionSyntax`, `FSCheckOptionSyntax`, or `FSFormatOptionSyntax`). This dictionary uses the command option name as a key, and each entry has a value indicating what kind of entry to create. - Parameter option: The option for which to retrieve the URL. This value doesn't include leading dashes.
type FSUnaryFileSystem ¶
type FSUnaryFileSystem struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsunaryfilesystem
func FSUnaryFileSystemFromID ¶
func FSUnaryFileSystemFromID(id objc.ID) *FSUnaryFileSystem
type FSUnaryFileSystemOperations ¶
type FSUnaryFileSystemOperations interface {
ProbeResourceReplyHandler(resource *FSResource, reply func(*FSProbeResult, unsafe.Pointer))
LoadResourceOptionsReplyHandler(resource *FSResource, options *FSTaskOptions, reply func(*FSVolume, unsafe.Pointer))
UnloadResourceOptionsReplyHandler(resource *FSResource, options *FSTaskOptions, reply func(unsafe.Pointer))
}
FSUnaryFileSystemOperations wraps the ObjC protocol FSUnaryFileSystemOperations.
type FSVolume ¶
type FSVolume struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsvolume
func FSVolumeFromID ¶
func (*FSVolume) InitWithVolumeIDVolumeName ¶
func (o *FSVolume) InitWithVolumeIDVolumeName(volumeID *FSVolumeIdentifier, volumeName *FSFileName) *FSVolume
Creates a volume with the given identifier and name. - Parameters: - volumeID: An “FSVolumeIdentifier“ to uniquely identify the volume. For a network file system that supports multiple authenticated users, disambiguate the users by using qualifying data in the identifier. - volumeName: A name for the volume.
func (*FSVolume) SetName ¶
func (o *FSVolume) SetName(name *FSFileName)
func (*FSVolume) VolumeID ¶
func (o *FSVolume) VolumeID() *FSVolumeIdentifier
An identifier that uniquely identifies the volume.
type FSVolumeAccessCheckOperations ¶
type FSVolumeAccessCheckOperations interface {
CheckAccessToItemRequestedAccessReplyHandler(theItem *FSItem, access FSAccessMask, reply func(bool, unsafe.Pointer))
SetAccessCheckInhibited(accessCheckInhibited bool)
}
FSVolumeAccessCheckOperations wraps the ObjC protocol FSVolumeAccessCheckOperations.
type FSVolumeCaseFormat ¶
type FSVolumeCaseFormat int64
const ( // The volume is case sensitive. FSVolumeCaseFormatSensitive FSVolumeCaseFormat = 0 // The volume isn't case sensitive. FSVolumeCaseFormatInsensitive FSVolumeCaseFormat = 1 // The volume isn't case sensitive, but supports preserving the case of file and directory names. FSVolumeCaseFormatInsensitiveCasePreserving FSVolumeCaseFormat = 2 )
func (FSVolumeCaseFormat) String ¶
func (e FSVolumeCaseFormat) String() string
type FSVolumeIdentifier ¶
type FSVolumeIdentifier struct {
FSEntityIdentifier
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsvolumeidentifier
func FSVolumeIdentifierFromID ¶
func FSVolumeIdentifierFromID(id objc.ID) *FSVolumeIdentifier
type FSVolumeItemDeactivation ¶
type FSVolumeItemDeactivation interface {
DeactivateItemReplyHandler(item *FSItem, reply func(unsafe.Pointer))
ItemDeactivationPolicy() FSItemDeactivationOptions
}
FSVolumeItemDeactivation wraps the ObjC protocol FSVolumeItemDeactivation.
type FSVolumeKernelOffloadedIOOperations ¶
type FSVolumeKernelOffloadedIOOperations interface {
BlockmapFileOffsetLengthFlagsOperationIDPackerReplyHandler(file *FSItem, offset int64, length uint, flags FSBlockmapFlags, operationID uint, packer *FSExtentPacker, reply func(unsafe.Pointer))
CompleteIOForFileOffsetLengthStatusFlagsOperationIDReplyHandler(file *FSItem, offset int64, length uint, status unsafe.Pointer, flags FSCompleteIOFlags, operationID uint, reply func(unsafe.Pointer))
CreateFileNamedInDirectoryAttributesPackerReplyHandler(name *FSFileName, directory *FSItem, attributes *FSItemSetAttributesRequest, packer *FSExtentPacker, reply func(*FSItem, *FSFileName, unsafe.Pointer))
LookupItemNamedInDirectoryPackerReplyHandler(name *FSFileName, directory *FSItem, packer *FSExtentPacker, reply func(*FSItem, *FSFileName, unsafe.Pointer))
}
FSVolumeKernelOffloadedIOOperations wraps the ObjC protocol FSVolumeKernelOffloadedIOOperations.
type FSVolumeOpenCloseOperations ¶
type FSVolumeOpenCloseOperations interface {
OpenItemWithModesReplyHandler(item *FSItem, modes FSVolumeOpenModes, reply func(unsafe.Pointer))
CloseItemKeepingModesReplyHandler(item *FSItem, modes FSVolumeOpenModes, reply func(unsafe.Pointer))
SetOpenCloseInhibited(openCloseInhibited bool)
}
FSVolumeOpenCloseOperations wraps the ObjC protocol FSVolumeOpenCloseOperations.
type FSVolumeOpenModes ¶
type FSVolumeOpenModes uint64
const ( // The read mode. This mode is equivalent to POSIX `FREAD`. FSVolumeOpenModesRead FSVolumeOpenModes = 1 // The write mode. This mode is equivalent to POSIX `FRWITE`. FSVolumeOpenModesWrite FSVolumeOpenModes = 2 )
func (FSVolumeOpenModes) String ¶
func (e FSVolumeOpenModes) String() string
type FSVolumeOperations ¶
type FSVolumeOperations interface {
FSVolumePathConfOperations
MountWithOptionsReplyHandler(options *FSTaskOptions, reply func(unsafe.Pointer))
UnmountWithReplyHandler(reply func())
SynchronizeWithFlagsReplyHandler(flags FSSyncFlags, reply func(unsafe.Pointer))
GetAttributesOfItemReplyHandler(desiredAttributes *FSItemGetAttributesRequest, item *FSItem, reply func(*FSItemAttributes, unsafe.Pointer))
SetAttributesOnItemReplyHandler(newAttributes *FSItemSetAttributesRequest, item *FSItem, reply func(*FSItemAttributes, unsafe.Pointer))
LookupItemNamedInDirectoryReplyHandler(name *FSFileName, directory *FSItem, reply func(*FSItem, *FSFileName, unsafe.Pointer))
ReclaimItemReplyHandler(item *FSItem, reply func(unsafe.Pointer))
ReadSymbolicLinkReplyHandler(item *FSItem, reply func(*FSFileName, unsafe.Pointer))
CreateItemNamedTypeInDirectoryAttributesReplyHandler(name *FSFileName, type_ FSItemType, directory *FSItem, newAttributes *FSItemSetAttributesRequest, reply func(*FSItem, *FSFileName, unsafe.Pointer))
CreateSymbolicLinkNamedInDirectoryAttributesLinkContentsReplyHandler(name *FSFileName, directory *FSItem, newAttributes *FSItemSetAttributesRequest, contents *FSFileName, reply func(*FSItem, *FSFileName, unsafe.Pointer))
CreateLinkToItemNamedInDirectoryReplyHandler(item *FSItem, name *FSFileName, directory *FSItem, reply func(*FSFileName, unsafe.Pointer))
RemoveItemNamedFromDirectoryReplyHandler(item *FSItem, name *FSFileName, directory *FSItem, reply func(unsafe.Pointer))
RenameItemInDirectoryNamedToNewNameInDirectoryOverItemReplyHandler(item *FSItem, sourceDirectory *FSItem, sourceName *FSFileName, destinationName *FSFileName, destinationDirectory *FSItem, overItem *FSItem, reply func(*FSFileName, unsafe.Pointer))
EnumerateDirectoryStartingAtCookieVerifierProvidingAttributesUsingPackerReplyHandler(directory *FSItem, cookie uint64, verifier uint64, attributes *FSItemGetAttributesRequest, packer *FSDirectoryEntryPacker, reply func(uint64, unsafe.Pointer))
ActivateWithOptionsReplyHandler(options *FSTaskOptions, reply func(*FSItem, unsafe.Pointer))
DeactivateWithOptionsReplyHandler(options FSDeactivateOptions, reply func(unsafe.Pointer))
SupportedVolumeCapabilities() *FSVolumeSupportedCapabilities
VolumeStatistics() *FSStatFSResult
SetEnableOpenUnlinkEmulation(enableOpenUnlinkEmulation bool)
SetRequestedMountOptions(requestedMountOptions FSMountOptions)
}
FSVolumeOperations wraps the ObjC protocol FSVolumeOperations.
type FSVolumePathConfOperations ¶
type FSVolumePathConfOperations interface {
MaximumLinkCount() int
MaximumNameLength() int
RestrictsOwnershipChanges() bool
TruncatesLongNames() bool
}
FSVolumePathConfOperations wraps the ObjC protocol FSVolumePathConfOperations.
type FSVolumePreallocateOperations ¶
type FSVolumePreallocateOperations interface {
PreallocateSpaceForItemAtOffsetLengthFlagsReplyHandler(item *FSItem, offset int64, length uint, flags FSPreallocateFlags, reply func(uint, unsafe.Pointer))
SetPreallocateInhibited(preallocateInhibited bool)
}
FSVolumePreallocateOperations wraps the ObjC protocol FSVolumePreallocateOperations.
type FSVolumeReadWriteOperations ¶
type FSVolumeReadWriteOperations interface {
ReadFromFileOffsetLengthIntoBufferReplyHandler(item *FSItem, offset int64, length uint, buffer *FSMutableFileDataBuffer, reply func(uint, unsafe.Pointer))
WriteContentsToFileAtOffsetReplyHandler(contents *foundation.NSData, item *FSItem, offset int64, reply func(uint, unsafe.Pointer))
}
FSVolumeReadWriteOperations wraps the ObjC protocol FSVolumeReadWriteOperations.
type FSVolumeRenameOperations ¶
type FSVolumeRenameOperations interface {
SetVolumeNameReplyHandler(name *FSFileName, reply func(*FSFileName, unsafe.Pointer))
SetVolumeRenameInhibited(volumeRenameInhibited bool)
}
FSVolumeRenameOperations wraps the ObjC protocol FSVolumeRenameOperations.
type FSVolumeSupportedCapabilities ¶
type FSVolumeSupportedCapabilities struct {
foundation.NSObject
}
Apple documentation: https://developer.apple.com/documentation/fskit/fsvolumesupportedcapabilities
func FSVolumeSupportedCapabilitiesFromID ¶
func FSVolumeSupportedCapabilitiesFromID(id objc.ID) *FSVolumeSupportedCapabilities
func (*FSVolumeSupportedCapabilities) CaseFormat ¶
func (o *FSVolumeSupportedCapabilities) CaseFormat() FSVolumeCaseFormat
A value that indicates the volume's support for case sensitivity.
func (*FSVolumeSupportedCapabilities) DoesNotSupportImmutableFiles ¶
func (o *FSVolumeSupportedCapabilities) DoesNotSupportImmutableFiles() bool
A Boolean property that indicates the volume doesn't support immutable files. A `true` value means this volume doesn't support setting the `UF_IMMUTABLE` flag.
func (*FSVolumeSupportedCapabilities) DoesNotSupportRootTimes ¶
func (o *FSVolumeSupportedCapabilities) DoesNotSupportRootTimes() bool
A Boolan property that indicates the volume doesn't store reliable times for the root directory. If this value is `true` (Swift) or `YES` (Objective-C), the volume doesn't store reliable times for the root directory.
func (*FSVolumeSupportedCapabilities) DoesNotSupportSettingFilePermissions ¶
func (o *FSVolumeSupportedCapabilities) DoesNotSupportSettingFilePermissions() bool
A Boolean property that indicates the volume doesn't set file permissions. If this value is `true` (Swift) or `YES` (Objective-C), the volume doesn't support setting file permissions.
func (*FSVolumeSupportedCapabilities) DoesNotSupportVolumeSizes ¶
func (o *FSVolumeSupportedCapabilities) DoesNotSupportVolumeSizes() bool
A Boolean property that indicates the volume doesn't support certain volume size reports. A true value means the volume doesn't support determining values for total data blocks, available blocks, or free blocks, as in `f_blocks`, `f_bavail`, and `f_bfree` in the struct `statFS` returned by `statfs(2)`.
func (*FSVolumeSupportedCapabilities) SetCaseFormat ¶
func (o *FSVolumeSupportedCapabilities) SetCaseFormat(caseFormat FSVolumeCaseFormat)
func (*FSVolumeSupportedCapabilities) SetDoesNotSupportImmutableFiles ¶
func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportImmutableFiles(doesNotSupportImmutableFiles bool)
func (*FSVolumeSupportedCapabilities) SetDoesNotSupportRootTimes ¶
func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportRootTimes(doesNotSupportRootTimes bool)
func (*FSVolumeSupportedCapabilities) SetDoesNotSupportSettingFilePermissions ¶
func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportSettingFilePermissions(doesNotSupportSettingFilePermissions bool)
func (*FSVolumeSupportedCapabilities) SetDoesNotSupportVolumeSizes ¶
func (o *FSVolumeSupportedCapabilities) SetDoesNotSupportVolumeSizes(doesNotSupportVolumeSizes bool)
func (*FSVolumeSupportedCapabilities) SetSupports2TBFiles ¶
func (o *FSVolumeSupportedCapabilities) SetSupports2TBFiles(supports2TBFiles bool)
func (*FSVolumeSupportedCapabilities) SetSupports64BitObjectIDs ¶
func (o *FSVolumeSupportedCapabilities) SetSupports64BitObjectIDs(supports64BitObjectIDs bool)
func (*FSVolumeSupportedCapabilities) SetSupportsActiveJournal ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsActiveJournal(supportsActiveJournal bool)
func (*FSVolumeSupportedCapabilities) SetSupportsDocumentID ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsDocumentID(supportsDocumentID bool)
func (*FSVolumeSupportedCapabilities) SetSupportsFastStatFS ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsFastStatFS(supportsFastStatFS bool)
func (*FSVolumeSupportedCapabilities) SetSupportsHardLinks ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsHardLinks(supportsHardLinks bool)
func (*FSVolumeSupportedCapabilities) SetSupportsHiddenFiles ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsHiddenFiles(supportsHiddenFiles bool)
func (*FSVolumeSupportedCapabilities) SetSupportsJournal ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsJournal(supportsJournal bool)
func (*FSVolumeSupportedCapabilities) SetSupportsOpenDenyModes ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsOpenDenyModes(supportsOpenDenyModes bool)
func (*FSVolumeSupportedCapabilities) SetSupportsPersistentObjectIDs ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsPersistentObjectIDs(supportsPersistentObjectIDs bool)
func (*FSVolumeSupportedCapabilities) SetSupportsSharedSpace ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsSharedSpace(supportsSharedSpace bool)
func (*FSVolumeSupportedCapabilities) SetSupportsSparseFiles ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsSparseFiles(supportsSparseFiles bool)
func (*FSVolumeSupportedCapabilities) SetSupportsSymbolicLinks ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsSymbolicLinks(supportsSymbolicLinks bool)
func (*FSVolumeSupportedCapabilities) SetSupportsVolumeGroups ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsVolumeGroups(supportsVolumeGroups bool)
func (*FSVolumeSupportedCapabilities) SetSupportsZeroRuns ¶
func (o *FSVolumeSupportedCapabilities) SetSupportsZeroRuns(supportsZeroRuns bool)
func (*FSVolumeSupportedCapabilities) Supports2TBFiles ¶
func (o *FSVolumeSupportedCapabilities) Supports2TBFiles() bool
A Boolean property that indicates whether the volume supports file sizes larger than 4GB, and potentially up to 2TB.
func (*FSVolumeSupportedCapabilities) Supports64BitObjectIDs ¶
func (o *FSVolumeSupportedCapabilities) Supports64BitObjectIDs() bool
A Boolean property that indicates whether the volume supports 64-bit object IDs.
func (*FSVolumeSupportedCapabilities) SupportsActiveJournal ¶
func (o *FSVolumeSupportedCapabilities) SupportsActiveJournal() bool
A Boolean property that indicates whether the volume currently uses a journal for speeding recovery after an unplanned shutdown.
func (*FSVolumeSupportedCapabilities) SupportsDocumentID ¶
func (o *FSVolumeSupportedCapabilities) SupportsDocumentID() bool
A Boolean property that indicates whether the volume supports document IDs for document revisions. A document ID is an identifier that persists across object ID changes.
func (*FSVolumeSupportedCapabilities) SupportsFastStatFS ¶
func (o *FSVolumeSupportedCapabilities) SupportsFastStatFS() bool
A Boolean property that indicates whether the volume supports fast results when fetching file system statistics. A true value means this volume hints to upper layers to indicate that `statfs(2)` is fast enough that its results need not be cached by the caller.
func (*FSVolumeSupportedCapabilities) SupportsHardLinks ¶
func (o *FSVolumeSupportedCapabilities) SupportsHardLinks() bool
A Boolean property that indicates whether the volume supports hard links.
func (*FSVolumeSupportedCapabilities) SupportsHiddenFiles ¶
func (o *FSVolumeSupportedCapabilities) SupportsHiddenFiles() bool
A Boolean property that indicates whether the volume supports hidden files. A `true` value means the volume supports the `UF_HIDDEN` file flag.
func (*FSVolumeSupportedCapabilities) SupportsJournal ¶
func (o *FSVolumeSupportedCapabilities) SupportsJournal() bool
A Boolean property that indicates whether the volume supports a journal used to speed recovery in case of unplanned restart, such as a power outage or crash. This property doesn't necessarily mean the volume is actively using a journal.
func (*FSVolumeSupportedCapabilities) SupportsOpenDenyModes ¶
func (o *FSVolumeSupportedCapabilities) SupportsOpenDenyModes() bool
A Boolean property that indicates whether the volume supports open deny modes. These are modes such as "open for read write, deny write".
func (*FSVolumeSupportedCapabilities) SupportsPersistentObjectIDs ¶
func (o *FSVolumeSupportedCapabilities) SupportsPersistentObjectIDs() bool
A Boolean property that indicates whether the volume supports persistent object identifiers and can look up file system objects by their IDs.
func (*FSVolumeSupportedCapabilities) SupportsSharedSpace ¶
func (o *FSVolumeSupportedCapabilities) SupportsSharedSpace() bool
A Boolean property that indicates whether the volume supports multiple logical file systems that share space in a single "partition."
func (*FSVolumeSupportedCapabilities) SupportsSparseFiles ¶
func (o *FSVolumeSupportedCapabilities) SupportsSparseFiles() bool
A Boolean property that indicates whether the volume supports sparse files. A sparse file is a file that can have "holes" that the file system has never written to, and as a result don't consume space on disk.
func (*FSVolumeSupportedCapabilities) SupportsSymbolicLinks ¶
func (o *FSVolumeSupportedCapabilities) SupportsSymbolicLinks() bool
A Boolean property that indicates whether the volume supports symbolic links.
func (*FSVolumeSupportedCapabilities) SupportsVolumeGroups ¶
func (o *FSVolumeSupportedCapabilities) SupportsVolumeGroups() bool
A Boolean property that indicates whether the volume supports volume groups. Volume groups involve multiple logical file systems that the system can mount and unmount together, and for which the system can present common file system identifier information.
func (*FSVolumeSupportedCapabilities) SupportsZeroRuns ¶
func (o *FSVolumeSupportedCapabilities) SupportsZeroRuns() bool
A Boolean property that indicates whether the volume supports zero runs If this value is true, the volume keeps track of allocated but unwritten runs of a file so that it can substitute zeroes without actually writing zeroes to the media.
type FSVolumeXattrOperations ¶
type FSVolumeXattrOperations interface {
GetXattrNamedOfItemReplyHandler(name *FSFileName, item *FSItem, reply func(*foundation.NSData, unsafe.Pointer))
SetXattrNamedToDataOnItemPolicyReplyHandler(name *FSFileName, value *foundation.NSData, item *FSItem, policy FSSetXattrPolicy, reply func(unsafe.Pointer))
ListXattrsOfItemReplyHandler(item *FSItem, reply func(*foundation.NSArray[*FSFileName], unsafe.Pointer))
SetXattrOperationsInhibited(xattrOperationsInhibited bool)
}
FSVolumeXattrOperations wraps the ObjC protocol FSVolumeXattrOperations.
type Filesec_property_t ¶
type Filesec_property_t int64
const ( FILESEC_OWNER Filesec_property_t = 1 FILESEC_GROUP Filesec_property_t = 2 FILESEC_UUID Filesec_property_t = 3 FILESEC_MODE Filesec_property_t = 4 FILESEC_ACL Filesec_property_t = 5 FILESEC_GRPUUID Filesec_property_t = 6 FILESEC_ACL_RAW Filesec_property_t = 100 FILESEC_ACL_ALLOCSIZE Filesec_property_t = 101 )
func (Filesec_property_t) String ¶
func (e Filesec_property_t) String() string
type Ipc_info_object_type_t ¶
type Ipc_info_object_type_t int64
const ( IPC_OTYPE_NONE Ipc_info_object_type_t = 0 IPC_OTYPE_THREAD_CONTROL Ipc_info_object_type_t = 1 IPC_OTYPE_TASK_CONTROL Ipc_info_object_type_t = 2 IPC_OTYPE_HOST Ipc_info_object_type_t = 3 IPC_OTYPE_HOST_PRIV Ipc_info_object_type_t = 4 IPC_OTYPE_PROCESSOR Ipc_info_object_type_t = 5 IPC_OTYPE_PROCESSOR_SET Ipc_info_object_type_t = 6 IPC_OTYPE_PROCESSOR_SET_NAME Ipc_info_object_type_t = 7 IPC_OTYPE_TIMER Ipc_info_object_type_t = 8 IPC_OTYPE_PORT_SUBST_ONCE Ipc_info_object_type_t = 9 IPC_OTYPE_MIG Ipc_info_object_type_t = 10 IPC_OTYPE_MEMORY_OBJECT Ipc_info_object_type_t = 11 IPC_OTYPE_XMM_PAGER Ipc_info_object_type_t = 12 IPC_OTYPE_XMM_KERNEL Ipc_info_object_type_t = 13 IPC_OTYPE_XMM_REPLY Ipc_info_object_type_t = 14 IPC_OTYPE_UND_REPLY Ipc_info_object_type_t = 15 IPC_OTYPE_HOST_NOTIFY Ipc_info_object_type_t = 16 IPC_OTYPE_HOST_SECURITY Ipc_info_object_type_t = 17 IPC_OTYPE_LEDGER Ipc_info_object_type_t = 18 IPC_OTYPE_MAIN_DEVICE Ipc_info_object_type_t = 19 IPC_OTYPE_TASK_NAME Ipc_info_object_type_t = 20 IPC_OTYPE_SUBSYSTEM Ipc_info_object_type_t = 21 IPC_OTYPE_IO_DONE_QUEUE Ipc_info_object_type_t = 22 IPC_OTYPE_SEMAPHORE Ipc_info_object_type_t = 23 IPC_OTYPE_LOCK_SET Ipc_info_object_type_t = 24 IPC_OTYPE_CLOCK Ipc_info_object_type_t = 25 IPC_OTYPE_CLOCK_CTRL Ipc_info_object_type_t = 26 IPC_OTYPE_IOKIT_IDENT Ipc_info_object_type_t = 27 IPC_OTYPE_NAMED_ENTRY Ipc_info_object_type_t = 28 IPC_OTYPE_IOKIT_CONNECT Ipc_info_object_type_t = 29 IPC_OTYPE_IOKIT_OBJECT Ipc_info_object_type_t = 30 IPC_OTYPE_UPL Ipc_info_object_type_t = 31 IPC_OTYPE_MEM_OBJ_CONTROL Ipc_info_object_type_t = 32 IPC_OTYPE_AU_SESSIONPORT Ipc_info_object_type_t = 33 IPC_OTYPE_FILEPORT Ipc_info_object_type_t = 34 IPC_OTYPE_LABELH Ipc_info_object_type_t = 35 IPC_OTYPE_TASK_RESUME Ipc_info_object_type_t = 36 IPC_OTYPE_VOUCHER Ipc_info_object_type_t = 37 IPC_OTYPE_VOUCHER_ATTR_CONTROL Ipc_info_object_type_t = 38 IPC_OTYPE_WORK_INTERVAL Ipc_info_object_type_t = 39 IPC_OTYPE_UX_HANDLER Ipc_info_object_type_t = 40 IPC_OTYPE_UEXT_OBJECT Ipc_info_object_type_t = 41 IPC_OTYPE_ARCADE_REG Ipc_info_object_type_t = 42 IPC_OTYPE_EVENTLINK Ipc_info_object_type_t = 43 IPC_OTYPE_TASK_INSPECT Ipc_info_object_type_t = 44 IPC_OTYPE_TASK_READ Ipc_info_object_type_t = 45 IPC_OTYPE_THREAD_INSPECT Ipc_info_object_type_t = 46 IPC_OTYPE_THREAD_READ Ipc_info_object_type_t = 47 IPC_OTYPE_SUID_CRED Ipc_info_object_type_t = 48 IPC_OTYPE_HYPERVISOR Ipc_info_object_type_t = 49 IPC_OTYPE_TASK_ID_TOKEN Ipc_info_object_type_t = 50 IPC_OTYPE_TASK_FATAL Ipc_info_object_type_t = 51 IPC_OTYPE_KCDATA Ipc_info_object_type_t = 52 IPC_OTYPE_EXCLAVES_RESOURCE Ipc_info_object_type_t = 53 IPC_OTYPE_THREAD_RESUME Ipc_info_object_type_t = 54 IPC_OTYPE_UNKNOWN Ipc_info_object_type_t = 4294967295 )
func (Ipc_info_object_type_t) String ¶
func (e Ipc_info_object_type_t) String() string
type Launch_data_type_t ¶
type Launch_data_type_t int64
const ( LAUNCH_DATA_DICTIONARY Launch_data_type_t = 1 LAUNCH_DATA_ARRAY Launch_data_type_t = 2 LAUNCH_DATA_FD Launch_data_type_t = 3 LAUNCH_DATA_INTEGER Launch_data_type_t = 4 LAUNCH_DATA_REAL Launch_data_type_t = 5 LAUNCH_DATA_BOOL Launch_data_type_t = 6 LAUNCH_DATA_STRING Launch_data_type_t = 7 LAUNCH_DATA_OPAQUE Launch_data_type_t = 8 LAUNCH_DATA_ERRNO Launch_data_type_t = 9 LAUNCH_DATA_MACHPORT Launch_data_type_t = 10 )
func (Launch_data_type_t) String ¶
func (e Launch_data_type_t) String() string
type MDLabelDomain ¶
type MDLabelDomain int64
@typedef MDLabelDomain @abstract These constants are used to specify a domain to MDLabelCreate().
const ( KMDLabelUserDomain MDLabelDomain = 0 KMDLabelLocalDomain MDLabelDomain = 1 )
func (MDLabelDomain) String ¶
func (e MDLabelDomain) String() string
type MDQueryOptionFlags ¶
type MDQueryOptionFlags int64
const ( KMDQuerySynchronous MDQueryOptionFlags = 1 KMDQueryWantsUpdates MDQueryOptionFlags = 4 KMDQueryAllowFSTranslation MDQueryOptionFlags = 8 )
func (MDQueryOptionFlags) String ¶
func (e MDQueryOptionFlags) String() string
type MDQuerySortOptionFlags ¶
type MDQuerySortOptionFlags int64
@enum MDQuerySortOptionFlags @constant kMDQueryReverseSortOrderFlag Sort the attribute in reverse order.
const (
KMDQueryReverseSortOrderFlag MDQuerySortOptionFlags = 1
)
func (MDQuerySortOptionFlags) String ¶
func (e MDQuerySortOptionFlags) String() string
type Mach_vm_range_flags_t ¶
type Mach_vm_range_flags_t int64
const (
MACH_VM_RANGE_NONE Mach_vm_range_flags_t = 0
)
func (Mach_vm_range_flags_t) String ¶
func (e Mach_vm_range_flags_t) String() string
type Mach_vm_range_flavor_t ¶
type Mach_vm_range_flavor_t int64
const ( MACH_VM_RANGE_FLAVOR_INVALID Mach_vm_range_flavor_t = 0 MACH_VM_RANGE_FLAVOR_V1 Mach_vm_range_flavor_t = 1 )
func (Mach_vm_range_flavor_t) String ¶
func (e Mach_vm_range_flavor_t) String() string
type Mach_vm_range_tag_t ¶
type Mach_vm_range_tag_t int64
const ( MACH_VM_RANGE_DEFAULT Mach_vm_range_tag_t = 0 MACH_VM_RANGE_DATA Mach_vm_range_tag_t = 1 MACH_VM_RANGE_FIXED Mach_vm_range_tag_t = 2 )
func (Mach_vm_range_tag_t) String ¶
func (e Mach_vm_range_tag_t) String() string
type Mpo_flags_t ¶
type Mpo_flags_t int64
const ( MPO_PORT Mpo_flags_t = 0 MPO_SERVICE_PORT Mpo_flags_t = 1024 MPO_CONNECTION_PORT Mpo_flags_t = 2048 MPO_REPLY_PORT Mpo_flags_t = 4096 MPO_WEAK_REPLY_PORT Mpo_flags_t = 16384 MPO_NOTIFICATION_PORT Mpo_flags_t = 17408 MPO_EXCEPTION_PORT Mpo_flags_t = 32768 MPO_CONNECTION_PORT_WITH_PORT_ARRAY Mpo_flags_t = 65536 )
func (Mpo_flags_t) String ¶
func (e Mpo_flags_t) String() string
type Os_clockid_t ¶
type Os_clockid_t int64
const (
OS_CLOCK_MACH_ABSOLUTE_TIME Os_clockid_t = 32
)
func (Os_clockid_t) String ¶
func (e Os_clockid_t) String() string
type Os_log_type_t ¶
type Os_log_type_t int64
const ( OS_LOG_TYPE_DEFAULT Os_log_type_t = 0 OS_LOG_TYPE_INFO Os_log_type_t = 1 OS_LOG_TYPE_DEBUG Os_log_type_t = 2 OS_LOG_TYPE_ERROR Os_log_type_t = 16 OS_LOG_TYPE_FAULT Os_log_type_t = 17 )
func (Os_log_type_t) String ¶
func (e Os_log_type_t) String() string
type Ptrauth_key ¶
type Ptrauth_key int64
const ( Ptrauth_key_none Ptrauth_key = -1 Ptrauth_key_asia Ptrauth_key = 0 Ptrauth_key_asib Ptrauth_key = 1 Ptrauth_key_asda Ptrauth_key = 2 Ptrauth_key_asdb Ptrauth_key = 3 Ptrauth_key_process_independent_code Ptrauth_key = 0 Ptrauth_key_process_dependent_code Ptrauth_key = 1 Ptrauth_key_process_independent_data Ptrauth_key = 2 Ptrauth_key_process_dependent_data Ptrauth_key = 3 Ptrauth_key_return_address Ptrauth_key = 1 Ptrauth_key_frame_pointer Ptrauth_key = 3 Ptrauth_key_function_pointer Ptrauth_key = 0 Ptrauth_key_block_function Ptrauth_key = 0 Ptrauth_key_cxx_vtable_pointer Ptrauth_key = 2 Ptrauth_key_method_list_pointer Ptrauth_key = 2 Ptrauth_key_objc_isa_pointer Ptrauth_key = 2 Ptrauth_key_objc_super_pointer Ptrauth_key = 2 Ptrauth_key_objc_sel_pointer Ptrauth_key = 3 Ptrauth_key_objc_class_ro_pointer Ptrauth_key = 2 Ptrauth_key_block_descriptor_pointer Ptrauth_key = 2 Ptrauth_key_init_fini_pointer Ptrauth_key = 0 )
func (Ptrauth_key) String ¶
func (e Ptrauth_key) String() string
type Qos_class_t ¶
type Qos_class_t uint32
const ( QOS_CLASS_USER_INTERACTIVE Qos_class_t = 33 QOS_CLASS_USER_INITIATED Qos_class_t = 25 QOS_CLASS_DEFAULT Qos_class_t = 21 QOS_CLASS_UTILITY Qos_class_t = 17 QOS_CLASS_BACKGROUND Qos_class_t = 9 QOS_CLASS_UNSPECIFIED Qos_class_t = 0 )
func (Qos_class_t) String ¶
func (e Qos_class_t) String() string
type Virtual_memory_guard_exception_code_t ¶
type Virtual_memory_guard_exception_code_t int64
const ( KGUARD_EXC_DEALLOC_GAP Virtual_memory_guard_exception_code_t = 1 KGUARD_EXC_RECLAIM_COPYIO_FAILURE Virtual_memory_guard_exception_code_t = 2 KGUARD_EXC_RECLAIM_INDEX_FAILURE Virtual_memory_guard_exception_code_t = 4 KGUARD_EXC_RECLAIM_DEALLOCATE_FAILURE Virtual_memory_guard_exception_code_t = 8 KGUARD_EXC_RECLAIM_ACCOUNTING_FAILURE Virtual_memory_guard_exception_code_t = 9 KGUARD_EXC_SEC_IOPL_ON_EXEC_PAGE Virtual_memory_guard_exception_code_t = 10 KGUARD_EXC_SEC_EXEC_ON_IOPL_PAGE Virtual_memory_guard_exception_code_t = 11 KGUARD_EXC_SEC_UPL_WRITE_ON_EXEC_REGION Virtual_memory_guard_exception_code_t = 12 KGUARD_EXC_LARGE_ALLOCATION_TELEMETRY Virtual_memory_guard_exception_code_t = 13 KGUARD_EXC_SEC_ACCESS_FAULT Virtual_memory_guard_exception_code_t = 98 KGUARD_EXC_SEC_ASYNC_ACCESS_FAULT Virtual_memory_guard_exception_code_t = 99 KGUARD_EXC_SEC_COPY_DENIED Virtual_memory_guard_exception_code_t = 100 KGUARD_EXC_SEC_SHARING_DENIED Virtual_memory_guard_exception_code_t = 101 KGUARD_EXC_MTE_SYNC_FAULT Virtual_memory_guard_exception_code_t = 200 KGUARD_EXC_MTE_ASYNC_USER_FAULT Virtual_memory_guard_exception_code_t = 201 KGUARD_EXC_MTE_ASYNC_KERN_FAULT Virtual_memory_guard_exception_code_t = 202 KGUARD_EXC_GUARD_OBJECT_ASYNC_USER_FAULT Virtual_memory_guard_exception_code_t = 203 KGUARD_EXC_GUARD_OBJECT_ASYNC_KERN_FAULT Virtual_memory_guard_exception_code_t = 204 )
func (Virtual_memory_guard_exception_code_t) String ¶
func (e Virtual_memory_guard_exception_code_t) String() string
type Xpc_listener_create_flags_t ¶
type Xpc_listener_create_flags_t int64
const ( XPC_LISTENER_CREATE_NONE Xpc_listener_create_flags_t = 0 XPC_LISTENER_CREATE_INACTIVE Xpc_listener_create_flags_t = 1 XPC_LISTENER_CREATE_FORCE_MACH Xpc_listener_create_flags_t = 2 XPC_LISTENER_CREATE_FORCE_XPCSERVICE Xpc_listener_create_flags_t = 4 )
func (Xpc_listener_create_flags_t) String ¶
func (e Xpc_listener_create_flags_t) String() string
type Xpc_session_create_flags_t ¶
type Xpc_session_create_flags_t int64
const ( XPC_SESSION_CREATE_NONE Xpc_session_create_flags_t = 0 XPC_SESSION_CREATE_INACTIVE Xpc_session_create_flags_t = 1 XPC_SESSION_CREATE_MACH_PRIVILEGED Xpc_session_create_flags_t = 2 )
func (Xpc_session_create_flags_t) String ¶
func (e Xpc_session_create_flags_t) String() string
Source Files
¶
- FSBlockDeviceResource.go
- FSClient.go
- FSContainerIdentifier.go
- FSContainerStatus.go
- FSDirectoryEntryPacker.go
- FSEntityIdentifier.go
- FSExtentPacker.go
- FSFileName.go
- FSFileSystem.go
- FSGenericURLResource.go
- FSItem.go
- FSItemAttributes.go
- FSItemGetAttributesRequest.go
- FSItemSetAttributesRequest.go
- FSMetadataRange.go
- FSModuleIdentity.go
- FSMutableFileDataBuffer.go
- FSPathURLResource.go
- FSProbeResult.go
- FSResource.go
- FSStatFSResult.go
- FSTask.go
- FSTaskOptions.go
- FSUnaryFileSystem.go
- FSVolume.go
- FSVolumeIdentifier.go
- FSVolumeSupportedCapabilities.go
- doc.go
- fskit_enums.go
- fskit_externs.go
- fskit_functions.go
- fskit_protocols.go
- fskit_runtime.go