Struct LSMResult 

pub struct LSMResult { /* private fields */ }

An opaque Core Foundation type representing the result of a lookup (immutable).

See also Apple’s documentation

Implementations

impl LSMResult

pub unsafe fn new( alloc: Option<&CFAllocator>, mapref: &LSMMap, textref: &LSMText, num_results: CFIndex, flags: CFOptionFlags, ) -> CFRetained<LSMResult>

Returns, in decreasing order of likelihood, the categories or words that best match when a text is mapped into a map.

impl LSMResult

pub unsafe fn count(&self) -> CFIndex

Returns the number of results.

pub unsafe fn category(&self, n: CFIndex) -> LSMCategory

Returns the category of the n-th best (zero based) result.

pub unsafe fn score(&self, n: CFIndex) -> c_float

Returns the likelihood of the n-th best (zero based) result. A nan score often indicates that the category does not contain any token.

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

Returns the word for the n-th best (zero based) result.

pub unsafe fn token(&self, n: CFIndex) -> Option<CFRetained<CFData>>

Returns the token for the n-th best (zero based) result.

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

Returns the cluster of words for the n-th best (zero based) result.

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

Returns the cluster of tokens for the n-th best (zero based) result.

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 LSMResult

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for LSMResult

fn as_ref(&self) -> &CFType

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

impl AsRef<LSMResult> for LSMResult

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for LSMResult

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for LSMResult

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for LSMResult

fn type_id() -> CFTypeID

Returns the Core Foundation type identifier for LSM results.

impl Debug for LSMResult

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

Formats the value using the given formatter.

impl Deref for LSMResult

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for LSMResult

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 LSMResult

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for LSMResult

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 LSMResult

const ENCODING_REF: Encoding

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

impl Type for LSMResult

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 LSMResult