Struct MDLabel 

pub struct MDLabel { /* private fields */ }

Available on crate feature MDLabel only.

This is the type of a reference to an MDLabel.

See also Apple’s documentation

Implementations

impl MDLabel

pub unsafe fn new( allocator: Option<&CFAllocator>, display_name: Option<&CFString>, kind: Option<&CFString>, domain: MDLabelDomain, ) -> Option<CFRetained<MDLabel>>

Available on crate feature Metadata only.

Returns a label with the specified parameters. If there is already a label that exactly matches the parameters, a reference to the existing label will be returned; otherwise this will attempt to create a new label. A successful creation of a new private label definition will generate a kMDLabelAddedNotification. Note that this function can only create labels with “Private” visibility. Creating “Public” labels requires creating and installing a label bundle.

Parameter allocator: The CFAllocator which should be used to allocate memory for the label. This parameter may be NULL in which case the current default CFAllocator is used. Use kCFAllocatorNull to request a reference to an existing label only.

Parameter displayName: The label’s display name.

Parameter kind: The label’s kind string.

Parameter domain: The domain of the label (normally kMDLabelUserDomain).

Returns: An MDLabelRef, or NULL on failure.

Safety

• allocator might not allow None.
• display_name might not allow None.
• kind might not allow None.

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

Available on crate feature Metadata only.

Copy the value of the named attribute of a label.

Parameter label: The label.

Parameter name: The name of the desired attribute.

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

Safety

name might not allow None.

pub unsafe fn attribute_name(&self) -> Option<CFRetained<CFString>>

Available on crate feature Metadata only.

Copy the MDItem attribute name of a label. The attribute name can be used in an MDQuery string to search for MDItems that have the label set. The value of the MDItem attribute is a CFDate corresponding to the time the label was set on the item.

Parameter label: The label.

Returns: A CFStringRef, or NULL on failure.

pub unsafe fn delete(&self) -> bool

Available on crate feature Metadata only.

Deletes the user’s definition or override of the specified label from ~/Library/Metadata. Labels defined in bundles elsewhere in the filesystem cannot be deleted using this API. Deleting an override of a label merely makes the original definition of the label visible again and thus will generate a kMDLabelChangedNotification. A successful deletion of a private label definition will generate a kMDLabelRemovedNotification.

Parameter label: The label.

Returns: True if a label definition or override was successfully deleted.

pub unsafe fn set_attributes(&self, attrs: Option<&CFDictionary>) -> bool

Available on crate feature Metadata only.

Updates the attributes of the specified label. Labels defined in ~/Library/Metadata are modified directly. Labels defined in bundles elsewhere in the filesystem are overridden by creating a private copy of the label definition in ~/Library/Metadata. The updated attributes are then stored in the private copy. A successful call to MDLabelSetAttributes() will generate a kMDLabelChangedNotification.

Parameter label: The label.

Parameter attrs: A dictionary containing the attributes to be modified. To remove an attribute, include it in the dictionary with kCFNull as its value.

Returns: True if the label definition or override was successfully updated.

Safety

• attrs generics must be of the correct type.
• attrs might not allow None.

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 MDLabel

Available on crate feature Metadata only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for MDLabel

Available on crate feature Metadata only.

fn as_ref(&self) -> &CFType

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

impl AsRef<MDLabel> for MDLabel

Available on crate feature Metadata only.

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for MDLabel

Available on crate feature Metadata only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for MDLabel

Available on crate feature Metadata only.

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for MDLabel

Available on crate feature Metadata only.

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for MDLabel

Available on crate feature Metadata only.

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

Formats the value using the given formatter.

impl Deref for MDLabel

Available on crate feature Metadata only.

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for MDLabel

Available on crate feature Metadata only.

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 MDLabel

Available on crate feature Metadata only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for MDLabel

Available on crate feature Metadata only.

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 MDLabel

Available on crate feature Metadata only.

const ENCODING_REF: Encoding

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

impl Type for MDLabel

Available on crate feature Metadata only.

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 MDLabel

Available on crate feature Metadata only.