Struct FSItemAttributes

Source

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

Available on crate feature FSItem only.

Expand description

Attributes of an item, such as size, creation and modification times, and user and group identifiers.

Implementations§

Source §

impl FSItemAttributes

Source

pub unsafe fn invalidateAllProperties(&self)

Marks all attributes inactive.

Source

pub unsafe fn uid(&self) -> u32

The user identifier.

Source

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

Setter for uid.

Source

pub unsafe fn gid(&self) -> u32

The group identifier.

Source

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

Setter for gid.

Source

pub unsafe fn mode(&self) -> u32

The mode of the item.

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

Source

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

Setter for mode.

Source

pub unsafe fn type(&self) -> FSItemType

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

Source

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

Setter for type.

Source

pub unsafe fn linkCount(&self) -> u32

The number of hard links to the item.

Source

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

Setter for linkCount.

Source

pub unsafe fn flags(&self) -> u32

The item’s behavior flags.

See st_flags in stat.h for flag definitions.

Source

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

Setter for flags.

Source

pub unsafe fn size(&self) -> u64

The item’s size.

Source

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

Setter for size.

Source

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

Setter for [allocSize][Self::allocSize].

Source

pub unsafe fn fileID(&self) -> FSItemID

The item’s file identifier.

Source

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

Setter for fileID.

Source

pub unsafe fn parentID(&self) -> FSItemID

The identifier of the item’s parent.

Source

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

Setter for parentID.

Source

pub unsafe fn supportsLimitedXAttrs(&self) -> bool

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

Source

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

Setter for supportsLimitedXAttrs.

Source

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.

Source

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

Setter for inhibitKernelOffloadedIO.

Source

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.

Source §

impl FSItemAttributes

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}