Struct SKIndex 

pub struct SKIndex { /* private fields */ }

Available on crate feature SKIndex only.

Apple’s documentation

Implementations

impl SKIndex

pub unsafe fn with_url( in_url: Option<&CFURL>, in_index_name: Option<&CFString>, in_index_type: SKIndexType, in_analysis_properties: Option<&CFDictionary>, ) -> Option<CFRetained<SKIndex>>

Available on crate feature SearchKit only.

Safety

• in_url might not allow None.
• in_index_name might not allow None.
• in_analysis_properties generics must be of the correct type.
• in_analysis_properties might not allow None.

pub unsafe fn open_with_url( in_url: Option<&CFURL>, in_index_name: Option<&CFString>, in_write_access: bool, ) -> Option<CFRetained<SKIndex>>

Available on crate feature SearchKit only.

Safety

• in_url might not allow None.
• in_index_name might not allow None.

pub unsafe fn with_mutable_data( in_data: Option<&CFMutableData>, in_index_name: Option<&CFString>, in_index_type: SKIndexType, in_analysis_properties: Option<&CFDictionary>, ) -> Option<CFRetained<SKIndex>>

Available on crate feature SearchKit only.

Safety

• in_data might not allow None.
• in_index_name might not allow None.
• in_analysis_properties generics must be of the correct type.
• in_analysis_properties might not allow None.

pub unsafe fn open_with_data( in_data: Option<&CFData>, in_index_name: Option<&CFString>, ) -> Option<CFRetained<SKIndex>>

Available on crate feature SearchKit only.

Safety

• in_data might not allow None.
• in_index_name might not allow None.

pub unsafe fn open_with_mutable_data( in_data: Option<&CFMutableData>, in_index_name: Option<&CFString>, ) -> Option<CFRetained<SKIndex>>

Available on crate feature SearchKit only.

Safety

• in_data might not allow None.
• in_index_name might not allow None.

pub unsafe fn flush(&self) -> bool

Available on crate feature SearchKit only.

pub unsafe fn set_maximum_bytes_before_flush( &self, in_bytes_for_update: CFIndex, )

Available on crate feature SearchKit only.

pub unsafe fn maximum_bytes_before_flush(&self) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn compact(&self) -> bool

Available on crate feature SearchKit only.

pub unsafe fn index_type(&self) -> SKIndexType

Available on crate feature SearchKit only.

pub unsafe fn analysis_properties(&self) -> Option<CFRetained<CFDictionary>>

Available on crate feature SearchKit only.

pub unsafe fn document_count(&self) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn close(&self)

Available on crate feature SearchKit only.

impl SKIndex

pub unsafe fn add_document_with_text( &self, in_document: Option<&SKDocument>, in_document_text: Option<&CFString>, in_can_replace: bool, ) -> bool

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.
• in_document_text might not allow None.

pub unsafe fn add_document( &self, in_document: Option<&SKDocument>, in_mime_type_hint: Option<&CFString>, in_can_replace: bool, ) -> bool

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.
• in_mime_type_hint might not allow None.

pub unsafe fn remove_document(&self, in_document: Option<&SKDocument>) -> bool

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.

pub unsafe fn document_properties( &self, in_document: Option<&SKDocument>, ) -> Option<CFRetained<CFDictionary>>

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.

pub unsafe fn set_document_properties( &self, in_document: Option<&SKDocument>, in_properties: Option<&CFDictionary>, )

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.
• in_properties generics must be of the correct type.
• in_properties might not allow None.

pub unsafe fn document_state( &self, in_document: Option<&SKDocument>, ) -> SKDocumentIndexState

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.

pub unsafe fn document_id( &self, in_document: Option<&SKDocument>, ) -> SKDocumentID

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.

pub unsafe fn document_for_document_id( &self, in_document_id: SKDocumentID, ) -> Option<CFRetained<SKDocument>>

Available on crate features SearchKit and SKDocument only.

pub unsafe fn rename_document( &self, in_document: Option<&SKDocument>, in_new_name: Option<&CFString>, ) -> bool

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.
• in_new_name might not allow None.

pub unsafe fn move_document( &self, in_document: Option<&SKDocument>, in_new_parent: Option<&SKDocument>, ) -> bool

Available on crate features SearchKit and SKDocument only.

Safety

• in_document should be of the correct type.
• in_document might not allow None.
• in_new_parent should be of the correct type.
• in_new_parent might not allow None.

impl SKIndex

pub unsafe fn maximum_document_id(&self) -> SKDocumentID

Available on crate feature SearchKit only.

pub unsafe fn document_term_count( &self, in_document_id: SKDocumentID, ) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn term_id_array_for_document_id( &self, in_document_id: SKDocumentID, ) -> Option<CFRetained<CFArray>>

Available on crate feature SearchKit only.

pub unsafe fn document_term_frequency( &self, in_document_id: SKDocumentID, in_term_id: CFIndex, ) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn maximum_term_id(&self) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn term_document_count(&self, in_term_id: CFIndex) -> CFIndex

Available on crate feature SearchKit only.

pub unsafe fn document_id_array_for_term_id( &self, in_term_id: CFIndex, ) -> Option<CFRetained<CFArray>>

Available on crate feature SearchKit only.

pub unsafe fn term_string_for_term_id( &self, in_term_id: CFIndex, ) -> Option<CFRetained<CFString>>

Available on crate feature SearchKit only.

pub unsafe fn term_id_for_term_string( &self, in_term_string: Option<&CFString>, ) -> CFIndex

Available on crate feature SearchKit only.

Safety

in_term_string might not allow None.

impl SKIndex

pub unsafe fn copy_info_for_document_ids( &self, in_count: CFIndex, in_document_i_ds_array: *mut SKDocumentID, out_names_array: *mut *const CFString, out_parent_i_ds_array: *mut SKDocumentID, )

Available on crate features SearchKit and SKSearch only.

Safety

• in_document_i_ds_array must be a valid pointer.
• out_names_array must be a valid pointer.
• out_parent_i_ds_array must be a valid pointer.

pub unsafe fn copy_document_refs_for_document_ids( &self, in_count: CFIndex, in_document_i_ds_array: *mut SKDocumentID, out_document_refs_array: *mut *const SKDocument, )

Available on crate features SearchKit and SKSearch and SKDocument only.

Safety

• in_document_i_ds_array must be a valid pointer.
• out_document_refs_array must be a valid pointer.

pub unsafe fn copy_document_urls_for_document_ids( &self, in_count: CFIndex, in_document_i_ds_array: *mut SKDocumentID, out_document_ur_ls_array: *mut *const CFURL, )

Available on crate features SearchKit and SKSearch only.

Safety

• in_document_i_ds_array must be a valid pointer.
• out_document_ur_ls_array must be a valid pointer.

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 SKIndex

Available on crate feature SearchKit only.

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for SKIndex

Available on crate feature SearchKit only.

fn as_ref(&self) -> &CFType

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

impl AsRef<SKIndex> for SKIndex

Available on crate feature SearchKit only.

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SKIndex

Available on crate feature SearchKit only.

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for SKIndex

Available on crate feature SearchKit only.

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for SKIndex

Available on crate feature SearchKit only.

fn type_id() -> CFTypeID

Get the unique CFTypeID identifier for the type.

impl Debug for SKIndex

Available on crate feature SearchKit only.

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

Formats the value using the given formatter.

impl Deref for SKIndex

Available on crate feature SearchKit only.

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SKIndex

Available on crate feature SearchKit 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 SKIndex

Available on crate feature SearchKit only.

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for SKIndex

Available on crate feature SearchKit 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 SKIndex

Available on crate feature SearchKit only.

const ENCODING_REF: Encoding

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

impl Type for SKIndex

Available on crate feature SearchKit 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 SKIndex

Available on crate feature SearchKit only.