Trait FSFileSystemBase

pub unsafe trait FSFileSystemBase: NSObjectProtocol {
    // Provided methods
    unsafe fn containerStatus(&self) -> Retained<FSContainerStatus>
       where Self: Sized + Message { ... }
    unsafe fn setContainerStatus(&self, container_status: &FSContainerStatus)
       where Self: Sized + Message { ... }
    unsafe fn wipeResource_completionHandler(
        &self,
        resource: &FSBlockDeviceResource,
        completion: &DynBlock<dyn Fn(*mut NSError)>,
    )
       where Self: Sized + Message { ... }
}

Available on crate feature FSFileSystemBase only.

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

Both FSFileSystem and FSUnaryFileSystem conform to this protocol.

See also Apple’s documentation

Provided Methods

unsafe fn containerStatus(&self) -> Retained<FSContainerStatus>

where Self: Sized + Message,

Available on crate feature FSContainer only.

The status of the file system container, indicating its readiness and activity.

A file system container starts in the FSContainerState/notReady state, and then transitions to the other values of the FSContainerState enumeration. The following diagram illustrates the possible state transitions.

Your file system implementation updates this property as it changes state. Many events and operations may trigger a state transition, and some transitions depend on a specific file system’s design.

When using FSBlockDeviceResource, implement the following common state transitions:

• Calling loadResource transitions the state out of FSContainerState/notReady. For all block device file systems, this operation changes the state to either FSContainerState/ready or FSContainerState/blocked.
• Calling unloadResource transitions to the FSContainerState/notReady state, as does device termination.
• Transitioning from FSContainerState/blocked to FSContainerState/ready occurs as a result of resolving the underlying block favorably.
• Transitioning from FSContainerState/ready to FSContainerState/blocked is unusal, but valid.
• Transitioning between FSContainerState/ready and FSContainerState/active can result from maintenance operations such as FSManageableResourceMaintenanceOperations/startCheckWithTask:options:error:. For a FSUnaryFileSystem, this transition can also occur when activating or deactivating the container’s single volume.

unsafe fn setContainerStatus(&self, container_status: &FSContainerStatus)

where Self: Sized + Message,

Available on crate feature FSContainer only.

Setter for containerStatus.

unsafe fn wipeResource_completionHandler( &self, resource: &FSBlockDeviceResource, completion: &DynBlock<dyn Fn(*mut NSError)>, )

where Self: Sized + Message,

Available on crate features FSResource and block2 only.

Wipes existing file systems on the specified resource.

This method wraps the wipefs functionality from libutil. For more information, see the man page for wipefs.

• Parameters:
• resource: The FSBlockDeviceResource to wipe.
• completion: A block or closure that executes after the wipe operation completes. The completion handler receives a single parameter indicating any error that occurs during the operation. If the value is nil, the wipe operation succeeded.

Trait Implementations

impl ProtocolType for dyn FSFileSystemBase

const NAME: &'static str = "FSFileSystemBase"

The name of the Objective-C protocol that this type represents.

fn protocol() -> Option<&'static AnyProtocol>

Get a reference to the Objective-C protocol object that this type represents.

impl<T> ImplementedBy<T> for dyn FSFileSystemBase

where T: ?Sized + Message + FSFileSystemBase,

Implementations on Foreign Types

impl<T> FSFileSystemBase for ProtocolObject<T>

where T: ?Sized + FSFileSystemBase,

Implementors

impl FSFileSystemBase for FSFileSystem

Available on crate feature FSFileSystem only.

impl FSFileSystemBase for FSUnaryFileSystem

Available on crate feature FSUnaryFileSystem only.