Struct FSVolumeSupportedCapabilities

#[repr(C)]
pub struct FSVolumeSupportedCapabilities { /* private fields */ }

Available on crate feature FSVolume only.

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

See also Apple’s documentation

Implementations

impl FSVolumeSupportedCapabilities

pub unsafe fn supportsPersistentObjectIDs(&self) -> bool

A Boolean property that indicates whether the volume supports persistent object identifiers and can look up file system objects by their IDs.

pub unsafe fn setSupportsPersistentObjectIDs( &self, supports_persistent_object_i_ds: bool, )

Setter for supportsPersistentObjectIDs.

pub unsafe fn supportsSymbolicLinks(&self) -> bool

A Boolean property that indicates whether the volume supports symbolic links.

pub unsafe fn setSupportsSymbolicLinks(&self, supports_symbolic_links: bool)

Setter for supportsSymbolicLinks.

pub unsafe fn supportsHardLinks(&self) -> bool

A Boolean property that indicates whether the volume supports hard links.

pub unsafe fn setSupportsHardLinks(&self, supports_hard_links: bool)

Setter for supportsHardLinks.

pub unsafe fn supportsJournal(&self) -> 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.

pub unsafe fn setSupportsJournal(&self, supports_journal: bool)

Setter for supportsJournal.

pub unsafe fn supportsActiveJournal(&self) -> bool

A Boolean property that indicates whether the volume currently uses a journal for speeding recovery after an unplanned shutdown.

pub unsafe fn setSupportsActiveJournal(&self, supports_active_journal: bool)

Setter for supportsActiveJournal.

pub unsafe fn doesNotSupportRootTimes(&self) -> 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.

pub unsafe fn setDoesNotSupportRootTimes( &self, does_not_support_root_times: bool, )

Setter for doesNotSupportRootTimes.

pub unsafe fn supportsSparseFiles(&self) -> 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.

pub unsafe fn setSupportsSparseFiles(&self, supports_sparse_files: bool)

Setter for supportsSparseFiles.

pub unsafe fn supportsZeroRuns(&self) -> 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.

pub unsafe fn setSupportsZeroRuns(&self, supports_zero_runs: bool)

Setter for supportsZeroRuns.

pub unsafe fn supportsFastStatFS(&self) -> 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.

pub unsafe fn setSupportsFastStatFS(&self, supports_fast_stat_fs: bool)

Setter for supportsFastStatFS.

pub unsafe fn supports2TBFiles(&self) -> bool

A Boolean property that indicates whether the volume supports file sizes larger than 4GB, and potentially up to 2TB.

pub unsafe fn setSupports2TBFiles(&self, supports2_tb_files: bool)

Setter for supports2TBFiles.

pub unsafe fn supportsOpenDenyModes(&self) -> bool

A Boolean property that indicates whether the volume supports open deny modes.

These are modes such as “open for read write, deny write”.

pub unsafe fn setSupportsOpenDenyModes(&self, supports_open_deny_modes: bool)

Setter for supportsOpenDenyModes.

pub unsafe fn supportsHiddenFiles(&self) -> bool

A Boolean property that indicates whether the volume supports hidden files.

A true value means the volume supports the UF_HIDDEN file flag.

pub unsafe fn setSupportsHiddenFiles(&self, supports_hidden_files: bool)

Setter for supportsHiddenFiles.

pub unsafe fn doesNotSupportVolumeSizes(&self) -> 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).

pub unsafe fn setDoesNotSupportVolumeSizes( &self, does_not_support_volume_sizes: bool, )

Setter for doesNotSupportVolumeSizes.

pub unsafe fn supports64BitObjectIDs(&self) -> bool

A Boolean property that indicates whether the volume supports 64-bit object IDs.

pub unsafe fn setSupports64BitObjectIDs(&self, supports64_bit_object_i_ds: bool)

Setter for supports64BitObjectIDs.

pub unsafe fn supportsDocumentID(&self) -> 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.

pub unsafe fn setSupportsDocumentID(&self, supports_document_id: bool)

Setter for supportsDocumentID.

pub unsafe fn doesNotSupportImmutableFiles(&self) -> 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.

pub unsafe fn setDoesNotSupportImmutableFiles( &self, does_not_support_immutable_files: bool, )

Setter for doesNotSupportImmutableFiles.

pub unsafe fn doesNotSupportSettingFilePermissions(&self) -> 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.

pub unsafe fn setDoesNotSupportSettingFilePermissions( &self, does_not_support_setting_file_permissions: bool, )

Setter for doesNotSupportSettingFilePermissions.

pub unsafe fn supportsSharedSpace(&self) -> bool

A Boolean property that indicates whether the volume supports multiple logical file systems that share space in a single “partition.”

pub unsafe fn setSupportsSharedSpace(&self, supports_shared_space: bool)

Setter for supportsSharedSpace.

pub unsafe fn supportsVolumeGroups(&self) -> 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.

pub unsafe fn setSupportsVolumeGroups(&self, supports_volume_groups: bool)

Setter for supportsVolumeGroups.

pub unsafe fn caseFormat(&self) -> FSVolumeCaseFormat

A value that indicates the volume’s support for case sensitivity.

pub unsafe fn setCaseFormat(&self, case_format: FSVolumeCaseFormat)

Setter for caseFormat.

impl FSVolumeSupportedCapabilities

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for FSVolumeSupportedCapabilities

fn as_ref(&self) -> &AnyObject

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

impl AsRef<FSVolumeSupportedCapabilities> for FSVolumeSupportedCapabilities

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for FSVolumeSupportedCapabilities

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for FSVolumeSupportedCapabilities

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for FSVolumeSupportedCapabilities

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for FSVolumeSupportedCapabilities

const NAME: &'static str = "FSVolumeSupportedCapabilities"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<FSVolumeSupportedCapabilities as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for FSVolumeSupportedCapabilities

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

Formats the value using the given formatter.

impl Deref for FSVolumeSupportedCapabilities

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for FSVolumeSupportedCapabilities

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 FSVolumeSupportedCapabilities

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for FSVolumeSupportedCapabilities

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for FSVolumeSupportedCapabilities

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for FSVolumeSupportedCapabilities

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 FSVolumeSupportedCapabilities

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

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

impl DowncastTarget for FSVolumeSupportedCapabilities

impl Eq for FSVolumeSupportedCapabilities

impl NSCoding for FSVolumeSupportedCapabilities