Struct DADisk 

pub struct DADisk { /* private fields */ }

Available on crate feature DADisk only.

Type of a reference to DADisk instances.

See also Apple’s documentation

Implementations

impl DADisk

pub unsafe fn from_bsd_name( allocator: Option<&CFAllocator>, session: &DASession, name: NonNull<c_char>, ) -> Option<CFRetained<DADisk>>

Available on crate feature DASession only.

Creates a new disk object.

Parameter allocator: The allocator object to be used to allocate memory.

Parameter session: The DASession in which to contact Disk Arbitration.

Parameter name: The BSD device name.

Returns: A reference to a new DADisk.

The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

Safety

name must be a valid pointer.

pub unsafe fn from_volume_path( allocator: Option<&CFAllocator>, session: &DASession, path: &CFURL, ) -> Option<CFRetained<DADisk>>

Available on crate feature DASession only.

Creates a new disk object.

Parameter allocator: The allocator object to be used to allocate memory.

Parameter session: The DASession in which to contact Disk Arbitration.

Parameter path: The BSD mount point.

Returns: A reference to a new DADisk.

The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

pub unsafe fn bsd_name(&self) -> *const c_char

Obtains the BSD device name for the specified disk.

Parameter disk: The DADisk for which to obtain the BSD device name.

Returns: The disk’s BSD device name.

The BSD device name can be used with opendev() to open the BSD device.

pub unsafe fn description(&self) -> Option<CFRetained<CFDictionary>>

Obtains the Disk Arbitration description of the specified disk.

Parameter disk: The DADisk for which to obtain the Disk Arbitration description.

Returns: The disk’s Disk Arbitration description.

This function will contact Disk Arbitration to acquire the latest description of the specified disk, unless this function is called on a disk object passed within the context of a registered callback, in which case the description is current as of that callback event.

The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

pub unsafe fn whole_disk(&self) -> Option<CFRetained<DADisk>>

Obtain the associated whole disk object for the specified disk.

Parameter disk: The disk object.

Returns: The disk’s associated whole disk object.

The caller of this function receives a reference to the returned object. The caller also implicitly retains the object and is responsible for releasing it with CFRelease().

impl DADisk

pub unsafe fn mount( &self, path: Option<&CFURL>, options: DADiskMountOptions, callback: DADiskMountCallback, context: *mut c_void, )

Available on crate feature DADissenter only.

Mounts the volume at the specified disk object.

Parameter disk: The disk object.

Parameter path: The mount path. Pass NULL for a “standard” mount path.

Parameter options: The mount options.

Parameter callback: The callback function to call once the mount completes.

Parameter context: The user-defined context parameter to pass to the callback function.

Safety

• callback must be implemented correctly.
• context must be a valid pointer or null.

pub unsafe fn mount_with_arguments( &self, path: Option<&CFURL>, options: DADiskMountOptions, callback: DADiskMountCallback, context: *mut c_void, arguments: *mut *const CFString, )

Available on crate feature DADissenter only.

Mounts the volume at the specified disk object, with the specified mount options.

Parameter disk: The disk object.

Parameter path: The mount path. Pass NULL for a “standard” mount path.

Parameter options: The mount options.

Parameter callback: The callback function to call once the mount completes.

Parameter context: The user-defined context parameter to pass to the callback function.

Parameter arguments: The null-terminated list of mount options to pass to /sbin/mount -o.

Safety

• callback must be implemented correctly.
• context must be a valid pointer or null.
• arguments must be a valid pointer or null.

impl DADisk

pub unsafe fn rename( &self, name: &CFString, options: DADiskRenameOptions, callback: DADiskRenameCallback, context: *mut c_void, )

Available on crate feature DADissenter only.

Renames the volume at the specified disk object.

Parameter disk: The disk object.

Parameter options: The rename options.

Parameter callback: The callback function to call once the rename completes.

Parameter context: The user-defined context parameter to pass to the callback function.

Safety

• callback must be implemented correctly.
• context must be a valid pointer or null.

impl DADisk

pub unsafe fn unmount( &self, options: DADiskUnmountOptions, callback: DADiskUnmountCallback, context: *mut c_void, )

Available on crate feature DADissenter only.

Unmounts the volume at the specified disk object.

Parameter disk: The disk object.

Parameter options: The unmount options.

Parameter callback: The callback function to call once the unmount completes.

Parameter context: The user-defined context parameter to pass to the callback function.

Safety

• callback must be implemented correctly.
• context must be a valid pointer or null.

impl DADisk

pub unsafe fn eject( &self, options: DADiskEjectOptions, callback: DADiskEjectCallback, context: *mut c_void, )

Available on crate feature DADissenter only.

Ejects the specified disk object.

Parameter disk: The disk object.

Parameter options: The eject options.

Parameter callback: The callback function to call once the ejection completes.

Parameter context: The user-defined context parameter to pass to the callback function.

Safety

• callback must be implemented correctly.
• context must be a valid pointer or null.

impl DADisk

pub unsafe fn claim( &self, options: DADiskClaimOptions, release: DADiskClaimReleaseCallback, release_context: *mut c_void, callback: DADiskClaimCallback, callback_context: *mut c_void, )

Available on crate feature DADissenter only.

Claims the specified disk object for exclusive use.

Parameter disk: The disk object.

Parameter options: The claim options.

Parameter release: The callback function to call when the claim is to be released.

Parameter releaseContext: The user-defined context parameter to pass to the callback function.

Parameter callback: The callback function to call once the claim completes.

Parameter callbackContext: The user-defined context parameter to pass to the callback function.

Safety

• release must be implemented correctly.
• release_context must be a valid pointer or null.
• callback must be implemented correctly.
• callback_context must be a valid pointer or null.

pub unsafe fn is_claimed(&self) -> bool

Reports whether or not the disk is claimed.

Parameter disk: The disk object.

Returns: TRUE if the disk is claimed, otherwise FALSE.

pub unsafe fn unclaim(&self)

Unclaims the specified disk object.

Parameter disk: The disk object.

impl DADisk

pub unsafe fn options(&self) -> DADiskOptions

Obtains the options for the specified disk.

Parameter disk: The disk object for which to obtain the options.

Returns: The options.

pub unsafe fn set_options( &self, options: DADiskOptions, value: bool, ) -> DAReturn

Available on crate features DADissenter and libc only.

Sets the options for the specified disk.

Parameter disk: The disk object for which to set the options.

Parameter options: The options to set or clear.

Parameter value: Pass TRUE to set options; otherwise pass FALSE to clear options.

Returns: A result code.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for DADisk

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<CFType> for DADisk

fn as_ref(&self) -> &CFType

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<DADisk> for DADisk

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for DADisk

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for DADisk

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for DADisk

fn type_id() -> CFTypeID

Returns the type identifier of all DADisk instances.

impl Debug for DADisk

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for DADisk

type Target = CFType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for DADisk

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for DADisk

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for DADisk

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for DADisk

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for DADisk

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for DADisk