Struct MDItem

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

Available on crate features MDItem and Metadata only.

This is the type of a reference to MDItems.

See also Apple’s documentation

Implementations

impl MDItem

pub unsafe fn new( allocator: Option<&CFAllocator>, path: Option<&CFString>, ) -> Option<CFRetained<MDItem>>

Returns an metadata item for the given path.

Parameter allocator: The CFAllocator which should be used to allocate memory for the query and its sub-storage. This parameter may be NULL in which case the current default CFAllocator is used.

Parameter path: A path to the file for which to create the MDItem. [[Currently, the path must exist. MDItemRefs may or may not be uniqued. Use CFEqual() to compare them.]]

Returns: An MDItemRef, or NULL on failure.

pub unsafe fn with_url( allocator: Option<&CFAllocator>, url: Option<&CFURL>, ) -> Option<CFRetained<MDItem>>

Returns an metadata item for the given path.

Parameter allocator: The CFAllocator which should be used to allocate memory for the query and its sub-storage. This parameter may be NULL in which case the current default CFAllocator is used.

Parameter url: A url to the file for which to create the MDItem. [[Currently, the file must exist. MDItemRefs may or may not be uniqued. Use CFEqual() to compare them.]]

Returns: An MDItemRef, or NULL on failure.

impl MDItem

pub unsafe fn attribute( self: &MDItem, name: Option<&CFString>, ) -> Option<CFRetained<CFType>>

Returns the value of the given attribute for the item.

Parameter item: The item to be interrogated.

Parameter name: The name of the desired attribute.

Returns: A CFTypeRef, or NULL on failure, or if the attribute does not exist, of if the attribute is not readable.

pub unsafe fn attributes( self: &MDItem, names: Option<&CFArray>, ) -> Option<CFRetained<CFDictionary>>

Returns the values of the given attributes for the item.

Parameter item: The item to be interrogated.

Parameter names: A CFArray of the names of the desired attributes.

Returns: A CFDictionary where the keys are the attribute names, and the values are the attribute values, or NULL on failure. If an attribute does not exist, or is unreadable, there will be no key-value pair for it in the dictionary.

pub unsafe fn attribute_names(self: &MDItem) -> Option<CFRetained<CFArray>>

Returns an array of the attribute names existing in the item.

Parameter item: The item to be interrogated.

Returns: A CFArray of CFString attribute names, or NULL on failure.

impl MDItem

pub unsafe fn cache_file_descriptors( items: Option<&CFArray>, completion_handler: Option<&DynBlock<dyn Fn(*const CFArray)>>, )

Available on crate feature block2 only.

impl MDItem

pub unsafe fn labels(self: &MDItem) -> Option<CFRetained<CFArray>>

Available on crate feature MDLabel only.

Returns an array of the labels set on the specified item.

Parameter item: The item to be interrogated.

Returns: A CFArrayRef containing MDLabelRefs for the labels set on the item, or NULL on failure.

pub unsafe fn set_label(self: &MDItem, label: Option<&MDLabel>) -> bool

Available on crate feature MDLabel only.

Sets a label on the specified item.

Parameter item: The item to be updated.

Parameter label: The label.

Returns: True if the label was successfully set on the item, false otherwise.

pub unsafe fn remove_label(self: &MDItem, label: Option<&MDLabel>) -> bool

Available on crate feature MDLabel only.

Removes a label from the specified item.

Parameter item: The item to be updated.

Parameter label: The label.

Returns: True if the label was successfully removed from the item, false otherwise.

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

Available on crate features SearchKit and SKDocument only.

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

Available on crate features SearchKit and SKDocument only.

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 MDItem

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for MDItem

fn as_ref(&self) -> &CFType

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

impl AsRef<MDItem> for MDItem

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for MDItem

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for MDItem

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for MDItem

fn type_id() -> CFTypeID

Returns the type identifier of all MDItem instances.

impl Debug for MDItem

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

Formats the value using the given formatter.

impl Deref for MDItem

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDItem

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 MDItem

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for MDItem

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 MDItem

const ENCODING_REF: Encoding

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

impl Type for MDItem

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 MDItem