Struct FSProbeResult 

pub struct FSProbeResult { /* private fields */ }

Available on crate feature FSResource only.

An object that represents the results of a specific probe.

For any result value other than FSMatchResult/notRecognized, ensure the name and containerID values are non-nil. When a container or volume format doesn’t use a name, return an empty string. Also use an empty string in the case in which the format supports a name, but the value isn’t set yet.

Some container or volume formats may lack a durable UUID on which to base a container identifier. This situation is only valid for unary file systems. In such a case, return a random UUID.

With a block device resource, a probe operation may successfully get a result but encounter an error reading the name or UUID. If this happens, use whatever information is available, and provide an empty string or random UUID for the name or container ID, respectively.

See also Apple’s documentation

Implementations

impl FSProbeResult

pub unsafe fn result(&self) -> FSMatchResult

The match result, representing the recognition and usability of a probed resource.

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

pub unsafe fn containerID(&self) -> Option<Retained<FSContainerIdentifier>>

Available on crate features FSContainer and FSEntityIdentifier only.

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.

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

pub unsafe fn notRecognizedProbeResult() -> Retained<FSProbeResult>

A probe result for an unrecognized file system.

An unrecognized probe result contains nil for its FSProbeResult/name and FSProbeResult/containerID properties.

pub unsafe fn recognizedProbeResultWithName_containerID( name: &NSString, container_id: &FSContainerIdentifier, ) -> Retained<Self>

Available on crate features FSContainer and FSEntityIdentifier only.

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.

pub unsafe fn usableButLimitedProbeResult() -> Retained<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.

pub unsafe fn usableButLimitedProbeResultWithName_containerID( name: &NSString, container_id: &FSContainerIdentifier, ) -> Retained<Self>

Available on crate features FSContainer and FSEntityIdentifier only.

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.

pub unsafe fn usableProbeResultWithName_containerID( name: &NSString, container_id: &FSContainerIdentifier, ) -> Retained<Self>

Available on crate features FSContainer and FSEntityIdentifier only.

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.

impl FSProbeResult

Methods declared on superclass NSObject.

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 FSProbeResult

fn as_ref(&self) -> &AnyObject

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

impl AsRef<FSProbeResult> for FSProbeResult

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for FSProbeResult

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for FSProbeResult

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for FSProbeResult

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for FSProbeResult

const NAME: &'static str = "FSProbeResult"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<FSProbeResult 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 FSProbeResult

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

Formats the value using the given formatter.

impl Deref for FSProbeResult

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for FSProbeResult

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 FSProbeResult

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for FSProbeResult

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 FSProbeResult

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for FSProbeResult

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 FSProbeResult

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

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

impl DowncastTarget for FSProbeResult

impl Eq for FSProbeResult

impl NSCoding for FSProbeResult