Struct FSItemSetAttributesRequest 

pub struct FSItemSetAttributesRequest { /* private fields */ }

Available on crate feature FSItem only.

A request to set attributes on an item.

Methods that take attributes use this type to receive attribute values and to indicate which attributes they support. The various members of the parent type, FSItemAttributes, contain the values of the attributes to set.

Modify the consumedAttributes property to indicate which attributes your file system successfully used. FSKit calls the wasAttributeConsumed(_:) method to determine whether the file system successfully used a given attribute. Only set the attributes that your file system supports.

See also Apple’s documentation

Implementations

impl FSItemSetAttributesRequest

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

pub unsafe fn setConsumedAttributes(&self, consumed_attributes: FSItemAttribute)

Setter for consumedAttributes.

pub unsafe fn wasAttributeConsumed(&self, attribute: FSItemAttribute) -> bool

A method that indicates whether the file system used the given attribute.

• Parameter attribute: The FSItemAttribute to check.

impl FSItemSetAttributesRequest

Methods declared on superclass NSObject.

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

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

Methods from Deref<Target = FSItemAttributes>

pub unsafe fn invalidateAllProperties(&self)

Marks all attributes inactive.

pub unsafe fn uid(&self) -> u32

The user identifier.

pub unsafe fn setUid(&self, uid: u32)

Setter for uid.

pub unsafe fn gid(&self) -> u32

The group identifier.

pub unsafe fn setGid(&self, gid: u32)

Setter for gid.

pub unsafe fn mode(&self) -> u32

The mode of the item.

The mode is often used for setuid, setgid, and sticky bits.

pub unsafe fn setMode(&self, mode: u32)

Setter for mode.

pub unsafe fn type(&self) -> FSItemType

The item type, such as a regular file, directory, or symbolic link.

pub unsafe fn setType(&self, type: FSItemType)

Setter for type.

pub unsafe fn linkCount(&self) -> u32

The number of hard links to the item.

pub unsafe fn setLinkCount(&self, link_count: u32)

Setter for linkCount.

pub unsafe fn flags(&self) -> u32

The item’s behavior flags.

See st_flags in stat.h for flag definitions.

pub unsafe fn setFlags(&self, flags: u32)

Setter for flags.

pub unsafe fn size(&self) -> u64

The item’s size.

pub unsafe fn setSize(&self, size: u64)

Setter for size.

pub unsafe fn allocSize(&self) -> u64

The item’s allocated size.

pub unsafe fn setAllocSize(&self, alloc_size: u64)

Setter for allocSize.

pub unsafe fn fileID(&self) -> FSItemID

The item’s file identifier.

pub unsafe fn setFileID(&self, file_id: FSItemID)

Setter for fileID.

pub unsafe fn parentID(&self) -> FSItemID

The identifier of the item’s parent.

pub unsafe fn setParentID(&self, parent_id: FSItemID)

Setter for parentID.

pub unsafe fn supportsLimitedXAttrs(&self) -> bool

A Boolean value that indicates whether the item supports a limited set of extended attributes.

pub unsafe fn setSupportsLimitedXAttrs(&self, supports_limited_x_attrs: bool)

Setter for supportsLimitedXAttrs.

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

pub unsafe fn setInhibitKernelOffloadedIO( &self, inhibit_kernel_offloaded_io: bool, )

Setter for inhibitKernelOffloadedIO.

pub unsafe fn isValid(&self, 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.

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 FSItemSetAttributesRequest

fn as_ref(&self) -> &AnyObject

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

impl AsRef<FSItemAttributes> for FSItemSetAttributesRequest

fn as_ref(&self) -> &FSItemAttributes

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

impl AsRef<FSItemSetAttributesRequest> for FSItemSetAttributesRequest

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for FSItemSetAttributesRequest

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for FSItemSetAttributesRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<FSItemAttributes> for FSItemSetAttributesRequest

fn borrow(&self) -> &FSItemAttributes

Immutably borrows from an owned value.

impl Borrow<NSObject> for FSItemSetAttributesRequest

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for FSItemSetAttributesRequest

const NAME: &'static str = "FSItemSetAttributesRequest"

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

type Super = FSItemAttributes

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for FSItemSetAttributesRequest

type Target = FSItemAttributes

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for FSItemSetAttributesRequest

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 FSItemSetAttributesRequest

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for FSItemSetAttributesRequest

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 FSItemSetAttributesRequest

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for FSItemSetAttributesRequest

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 FSItemSetAttributesRequest

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

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

impl DowncastTarget for FSItemSetAttributesRequest

impl Eq for FSItemSetAttributesRequest

impl NSCoding for FSItemSetAttributesRequest