Struct LSMMap 

pub struct LSMMap { /* private fields */ }

An opaque Core Foundation type representing an LSM map (mutable).

See also Apple’s documentation

Implementations

impl LSMMap

pub unsafe fn new( alloc: Option<&CFAllocator>, flags: CFOptionFlags, ) -> CFRetained<LSMMap>

Creates a new LSM map. Call CFRelease to dispose.

impl LSMMap

pub unsafe fn set_properties(&self, properties: &CFDictionary)

Set a dictionary of properties for the map. LSM makes its own copy of the properties, there’s no need to retain them past this call.

Safety

properties generics must be of the correct type.

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

Get a dictionary of properties for the map. LSM retains ownership of this dictionary, do not release it.

pub unsafe fn start_training(&self) -> i32

Puts the map into training mode, preparing it for the addition of more categories and/or texts. This function will be somewhat expensive, as it requires substantial data structure reorganization.

pub unsafe fn add_category(&self) -> LSMCategory

Adds another category and returns its category identifier.

pub unsafe fn category_count(&self) -> CFIndex

Returns the number of categories in the map.

pub unsafe fn set_stop_words(&self, textref: &LSMText) -> i32

The specified words will be omitted from all classification efforts. Needs to be called before any other texts are created. The textref is no longer needed after this call.

pub unsafe fn add_text(&self, textref: &LSMText, category: LSMCategory) -> i32

Adds a training text to the given category. The textref is no longer needed after this call.

pub unsafe fn add_text_with_weight( &self, textref: &LSMText, category: LSMCategory, weight: c_float, ) -> i32

Adds a training text to the given category with a weight different from 1. The weight may be negative, but global counts will be pinned to 0. The textref is no longer needed after this call.

pub unsafe fn compile(&self) -> i32

Compiles the map into executable form and puts it into mapping mode, preparing it for the classification of texts. This function is computationally expensive.

pub unsafe fn new_clusters( alloc: Option<&CFAllocator>, mapref: &LSMMap, subset: Option<&CFArray>, num_clusters: CFIndex, flags: CFOptionFlags, ) -> Option<CFRetained<CFArray>>

Compute a set of clusters grouping similar categories or words. If subset is non-NULL, only perform clustering on the categories or words listed.

Safety

subset generic must be of the correct type.

impl LSMMap

pub unsafe fn apply_clusters(&self, clusters: &CFArray) -> i32

Group categories or words (tokens) into the specified sets of clusters.

Safety

clusters generic must be of the correct type.

impl LSMMap

pub unsafe fn write_to_url(&self, file: &CFURL, flags: CFOptionFlags) -> i32

Compiles the map if necessary and then stores it into the given file.

pub unsafe fn from_url( alloc: Option<&CFAllocator>, file: &CFURL, flags: CFOptionFlags, ) -> Option<CFRetained<LSMMap>>

Loads a map from a given file.

impl LSMMap

pub unsafe fn write_to_stream( &self, textref: Option<&LSMText>, stream: &CFWriteStream, options: CFOptionFlags, ) -> i32

Writes information about a map and/or text to a stream in text form

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

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

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 LSMMap

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for LSMMap

fn as_ref(&self) -> &CFType

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

impl AsRef<LSMMap> for LSMMap

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for LSMMap

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for LSMMap

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for LSMMap

fn type_id() -> CFTypeID

Returns the Core Foundation type identifier for LSM maps.

impl Debug for LSMMap

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

Formats the value using the given formatter.

impl Deref for LSMMap

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for LSMMap

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 LSMMap

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for LSMMap

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 LSMMap

const ENCODING_REF: Encoding

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

impl Type for LSMMap

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 LSMMap