Struct NLTagger 

#[repr(C)]
pub struct NLTagger {
    pub ptr: Id<Object>,
}

A tagger that analyzes natural language text.

Fields

ptr: Id<Object>

The raw pointer to the Objective-C object.

Implementations

impl NLTagger

pub fn init_with_tag_schemes( &mut self, tag_schemes: NSArray<NLTagScheme>, ) -> Self

where Self: Sized + FromId,

Creates a linguistic tagger instance using the specified tag schemes and options.

pub fn string(&self) -> Option<NSString>

The string being analyzed by the linguistic tagger.

pub fn set_string(&mut self, value: Option<NSString>)

Sets the string being analyzed by the linguistic tagger.

pub fn available_tag_schemes_for_unit_language( unit: NLTokenUnit, language: &NLLanguage, ) -> NSArray<NLTagScheme>

Retrieves the tag schemes available for a particular unit (like word or sentence) and language on the current device.

pub fn request_assets_for_language_tag_scheme_completion_handler<F>( language: &NLLanguage, tag_scheme: &NLTagScheme, completion_hanlder: F, )

where F: IntoConcreteBlock<(NLTaggerAssetsResult, NSError), Ret = ()> + 'static,

Asks the Natural Language framework to load any missing assets for a tag scheme onto the device for the given language.

pub fn tag_schemes(&self) -> NSArray<NLTagScheme>

The tag schemes configured for this linguistic tagger.

pub fn dominant_language(&self) -> Option<NLLanguage>

The dominant language of the string set for the linguistic tagger.

pub fn set_dominant_language(&self, language: Option<&NLLanguage>)

Sets the dominant language of the string set for the linguistic tagger.

pub fn set_language_range(&mut self, language: &NLLanguage, range: NSRange)

Sets the language for a range of text within the tagger’s string.

pub fn set_orthography_range( &mut self, orthography: &NSOrthography, range: NSRange, )

Sets the orthography for the specified range.

pub fn enumerate_tags_in_range_unit_scheme_options_using_block<F>( &self, range: NSRange, unit: NLTokenUnit, scheme: &NLTagScheme, options: &[NLTaggerOptions], block: F, )

where F: IntoConcreteBlock<(NLTag, NSRange, *mut bool), Ret = ()> + 'static,

Enumerates a block over the tagger’s string, given a range, token unit, and tag scheme.

pub fn tags_in_range_unit_scheme_options_token_ranges( &self, range: NSRange, unit: NLTokenUnit, scheme: &NLTagScheme, options: &[NLTaggerOptions], token_ranges: &mut NSArray<NSValue>, ) -> NSArray<NLTag>

Finds an array of linguistic tags and token ranges for a given string range and linguistic unit.

pub fn tag_at_index_unit_scheme_token_range( &self, character_index: UInt, unit: NLTokenUnit, scheme: &NLTagScheme, token_range: NSRangePointer, ) -> Option<NLTag>

Finds a tag for a given linguistic unit, for a single scheme, at the specified character position.

pub fn tag_hypotheses_at_index_unit_scheme_maximum_count_token_range( &self, character_index: UInt, unit: NLTokenUnit, scheme: &NLTagScheme, maximum_count: UInt, token_range: Option<NSRangePointer>, ) -> NSDictionary<NLTag, NSNumber>

Finds multiple possible tags for a given linguistic unit, for a single scheme, at the specified character position.

pub fn token_range_at_index_unit( &self, character_index: UInt, unit: NLTokenUnit, ) -> NSRange

Returns the range of the linguistic unit containing the specified character index.

pub fn token_range_for_range_unit( &self, range: NSRange, unit: NLTokenUnit, ) -> NSRange

Finds the entire range of all tokens of the specified linguistic unit contained completely or partially within the specified range.

pub fn set_models_for_tag_scheme( &mut self, models: &NSArray<NLModel>, tag_scheme: &NLTagScheme, )

Assigns models for a tag scheme.

pub fn models_for_tag_scheme( &self, tag_scheme: &NLTagScheme, ) -> NSArray<NLModel>

Returns the models that apply to the given tag scheme.

pub fn set_gazetteers_for_tag_scheme( &mut self, gazetteers: &NSArray<NLGazetteer>, tag_scheme: &NLTagScheme, )

Attaches gazetteers to a tag scheme, typically one gazetteer per language or one language-independent gazetteer.

pub fn gazetteers_for_tag_scheme( &self, tag_scheme: &NLTagScheme, ) -> NSArray<NLGazetteer>

Retrieves the gazetteers attached to a tag scheme.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Returns the class of self.

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

Returns a reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

Returns a mutable reference to the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

pub unsafe fn set_ivar<T>(&mut self, name: &str, value: T)

where T: Encode,

Sets the value of the ivar of self with the given name. Panics if self has no ivar with the given name. Unsafe because the caller must ensure that the ivar is actually of type T.

Trait Implementations

impl Clone for NLTagger

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NLTagger

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

Formats the value using the given formatter.

impl Deref for NLTagger

type Target = Object

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NLTagger

fn deref_mut(&mut self) -> &mut Object

Mutably dereferences the value.

impl Display for NLTagger

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

Formats the value using the given formatter.

impl Encode for NLTagger

fn encode() -> Encoding

Returns the Objective-C type encoding for Self.

impl FromId for NLTagger

unsafe fn from_id(ptr: id) -> Self

Returns Self representation of the object.

impl Hash for NLTagger

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 INLTagger for NLTagger

fn m_init_with_tag_schemes(&mut self, tag_schemes: NSArray<NLTagScheme>) -> Self

where Self: Sized + FromId,

Creates a linguistic tagger instance using the specified tag schemes and options.

fn p_string(&self) -> Option<NSString>

The string being analyzed by the linguistic tagger.

fn p_set_string(&mut self, value: Option<NSString>)

Sets the string being analyzed by the linguistic tagger.

fn m_available_tag_schemes_for_unit_language( unit: NLTokenUnit, language: &NLLanguage, ) -> NSArray<NLTagScheme>

Retrieves the tag schemes available for a particular unit (like word or sentence) and language on the current device.

fn m_request_assets_for_language_tag_scheme_completion_handler<F>( language: &NLLanguage, tag_scheme: &NLTagScheme, completion_hanlder: F, )

where F: IntoConcreteBlock<(NLTaggerAssetsResult, NSError), Ret = ()> + 'static,

Asks the Natural Language framework to load any missing assets for a tag scheme onto the device for the given language.

fn p_tag_schemes(&self) -> NSArray<NLTagScheme>

The tag schemes configured for this linguistic tagger.

fn p_dominant_language(&self) -> Option<NLLanguage>

The dominant language of the string set for the linguistic tagger.

fn p_set_dominant_language(&self, language: Option<&NLLanguage>)

Sets the dominant language of the string set for the linguistic tagger.

fn m_set_language_range(&mut self, language: &NLLanguage, range: NSRange)

Sets the language for a range of text within the tagger’s string.

fn m_set_orthography_range( &mut self, orthography: &NSOrthography, range: NSRange, )

Sets the orthography for the specified range.

fn m_enumerate_tags_in_range_unit_scheme_options_using_block<F>( &self, range: NSRange, unit: NLTokenUnit, scheme: &NLTagScheme, options: &[NLTaggerOptions], block: F, )

where F: IntoConcreteBlock<(NLTag, NSRange, *mut bool), Ret = ()> + 'static,

Enumerates a block over the tagger’s string, given a range, token unit, and tag scheme.

fn m_tags_in_range_unit_scheme_options_token_ranges( &self, range: NSRange, unit: NLTokenUnit, scheme: &NLTagScheme, options: &[NLTaggerOptions], token_ranges: &mut NSArray<NSValue>, ) -> NSArray<NLTag>

Finds an array of linguistic tags and token ranges for a given string range and linguistic unit.

fn m_tag_at_index_unit_scheme_token_range( &self, character_index: UInt, unit: NLTokenUnit, scheme: &NLTagScheme, token_range: NSRangePointer, ) -> Option<NLTag>

Finds a tag for a given linguistic unit, for a single scheme, at the specified character position.

fn m_tag_hypotheses_at_index_unit_scheme_maximum_count_token_range( &self, character_index: UInt, unit: NLTokenUnit, scheme: &NLTagScheme, maximum_count: UInt, token_range: Option<NSRangePointer>, ) -> NSDictionary<NLTag, NSNumber>

Finds multiple possible tags for a given linguistic unit, for a single scheme, at the specified character position.

fn m_token_range_at_index_unit( &self, character_index: UInt, unit: NLTokenUnit, ) -> NSRange

Returns the range of the linguistic unit containing the specified character index.

fn m_token_range_for_range_unit( &self, range: NSRange, unit: NLTokenUnit, ) -> NSRange

Finds the entire range of all tokens of the specified linguistic unit contained completely or partially within the specified range.

fn m_set_models_for_tag_scheme( &mut self, models: &NSArray<NLModel>, tag_scheme: &NLTagScheme, )

Assigns models for a tag scheme.

fn m_models_for_tag_scheme(&self, tag_scheme: &NLTagScheme) -> NSArray<NLModel>

Returns the models that apply to the given tag scheme.

fn m_set_gazetteers_for_tag_scheme( &mut self, gazetteers: &NSArray<NLGazetteer>, tag_scheme: &NLTagScheme, )

Attaches gazetteers to a tag scheme, typically one gazetteer per language or one language-independent gazetteer.

fn m_gazetteers_for_tag_scheme( &self, tag_scheme: &NLTagScheme, ) -> NSArray<NLGazetteer>

Retrieves the gazetteers attached to a tag scheme.

impl PNSObject for NLTagger

fn m_class<'a>() -> &'a Class

Returns the class object for the receiver’s class.

fn m_self(&self) -> id

Returns the receiver.

fn m_new() -> Self

where Self: Sized + FromId,

Allocates a new instance of the receiving class, sends it an init message, and returns the initialized object.

fn m_alloc() -> Self

where Self: Sized + FromId,

Returns a new instance of the receiving class.

fn m_initialize()

Initializes the class before it receives its first message.

fn ip_superclass<'a>() -> Option<&'a Class>

Returns the class object for the receiver’s superclass.

fn m_is_equal(&self, object: &Self) -> bool

Returns a Boolean value that indicates whether the receiver and a given object are equal.

fn p_hash(&self) -> UInt

Returns an integer that can be used as a table address in a hash table structure.

fn m_is_kind_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of given class or an instance of any class that inherits from that class.

fn m_is_member_of_class(&self, class: Class) -> bool

Returns a Boolean value that indicates whether the receiver is an instance of a given class.

fn m_responds_to_selector(&self, selector: Sel) -> bool

Returns a Boolean value that indicates whether the receiver implements or inherits a method that can respond to a specified message.

fn m_conforms_to_protocol(&self, protocol: Protocol) -> bool

Returns a Boolean value that indicates whether the receiver conforms to a given protocol.

fn p_description(&self) -> NSString

A textual representation of the receiver.

fn p_debug_description(&self) -> NSString

A textual representation of the receiver to use with a debugger.

fn m_perform_selector(&self, selector: Sel) -> id

Sends a specified message to the receiver and returns the result of the message.

fn m_perform_selector_with_object(&self, selector: Sel, with_object: id) -> id

Sends a message to the receiver with an object as the argument.

fn m_is_proxy(&self) -> bool

Returns a Boolean value that indicates whether the receiver does not descend from NSObject.

impl ToId for NLTagger

fn to_id(self) -> id

Returns id representation of the object.