objc2_vision/generated/
VNRecognizeTextRequest.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10/// Text recognition level options to favor speed over recognition accuracy. The VNRequestTextRecognitionLevelAccurate is the default option used by VNRecognizeTextRequest.
11///
12/// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnrequesttextrecognitionlevel?language=objc)
13// NS_ENUM
14#[repr(transparent)]
15#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
16pub struct VNRequestTextRecognitionLevel(pub NSInteger);
17impl VNRequestTextRecognitionLevel {
18    #[doc(alias = "VNRequestTextRecognitionLevelAccurate")]
19    pub const Accurate: Self = Self(0);
20    #[doc(alias = "VNRequestTextRecognitionLevelFast")]
21    pub const Fast: Self = Self(1);
22}
23
24unsafe impl Encode for VNRequestTextRecognitionLevel {
25    const ENCODING: Encoding = NSInteger::ENCODING;
26}
27
28unsafe impl RefEncode for VNRequestTextRecognitionLevel {
29    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
30}
31
32extern_class!(
33    /// A request that will detect regions of text and recognize the containing text in an image.
34    ///
35    ///
36    /// This request will generate VNRecognizedTextObservation objects describing the locations of text and the actual text recognized.
37    ///
38    /// See also [Apple's documentation](https://developer.apple.com/documentation/vision/vnrecognizetextrequest?language=objc)
39    #[unsafe(super(VNImageBasedRequest, VNRequest, NSObject))]
40    #[derive(Debug, PartialEq, Eq, Hash)]
41    #[cfg(feature = "VNRequest")]
42    pub struct VNRecognizeTextRequest;
43);
44
45#[cfg(feature = "VNRequest")]
46unsafe impl NSCopying for VNRecognizeTextRequest {}
47
48#[cfg(feature = "VNRequest")]
49unsafe impl CopyingHelper for VNRecognizeTextRequest {
50    type Result = Self;
51}
52
53#[cfg(feature = "VNRequest")]
54unsafe impl NSObjectProtocol for VNRecognizeTextRequest {}
55
56#[cfg(feature = "VNRequest")]
57unsafe impl VNRequestProgressProviding for VNRecognizeTextRequest {}
58
59#[cfg(feature = "VNRequest")]
60impl VNRecognizeTextRequest {
61    extern_methods!(
62        /// Returns all the supported languages for a given text recognition level. Note that a language supported in one recognition level might not be available in another.
63        #[deprecated]
64        #[unsafe(method(supportedRecognitionLanguagesForTextRecognitionLevel:revision:error:_))]
65        #[unsafe(method_family = none)]
66        pub unsafe fn supportedRecognitionLanguagesForTextRecognitionLevel_revision_error(
67            recognition_level: VNRequestTextRecognitionLevel,
68            request_revision: NSUInteger,
69        ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>;
70
71        /// Obtain the collection of supported recognition languages.
72        ///
73        /// This method will return the collection of all possible language identifiers that are recognized by the target request based on its current state of configuration at the time of the call.
74        ///
75        ///
76        /// Parameter `error`: The address of the variable that will be populated with the error if the call fails.
77        ///
78        ///
79        /// Returns: The collection of language identifiers, or nil if a failure occurs.
80        #[unsafe(method(supportedRecognitionLanguagesAndReturnError:_))]
81        #[unsafe(method_family = none)]
82        pub unsafe fn supportedRecognitionLanguagesAndReturnError(
83            &self,
84        ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>;
85
86        /// Specify the languages used for the detection. The order of the languages in the array defines the order in which languages will be used during the language processing.
87        /// The languages are specified as ISO language codes.
88        #[unsafe(method(recognitionLanguages))]
89        #[unsafe(method_family = none)]
90        pub unsafe fn recognitionLanguages(&self) -> Retained<NSArray<NSString>>;
91
92        /// Setter for [`recognitionLanguages`][Self::recognitionLanguages].
93        #[unsafe(method(setRecognitionLanguages:))]
94        #[unsafe(method_family = none)]
95        pub fn setRecognitionLanguages(&self, recognition_languages: &NSArray<NSString>);
96
97        /// An array of strings that will be used at the word recognition stage in addition to the recognition languages. The customWords list takes precedence over the standard lexicon.
98        #[unsafe(method(customWords))]
99        #[unsafe(method_family = none)]
100        pub fn customWords(&self) -> Retained<NSArray<NSString>>;
101
102        /// Setter for [`customWords`][Self::customWords].
103        #[unsafe(method(setCustomWords:))]
104        #[unsafe(method_family = none)]
105        pub fn setCustomWords(&self, custom_words: &NSArray<NSString>);
106
107        /// The recognition level selects which techniques will be used during the text recognition. There are trade-offs between performance and accuracy.
108        #[unsafe(method(recognitionLevel))]
109        #[unsafe(method_family = none)]
110        pub fn recognitionLevel(&self) -> VNRequestTextRecognitionLevel;
111
112        /// Setter for [`recognitionLevel`][Self::recognitionLevel].
113        #[unsafe(method(setRecognitionLevel:))]
114        #[unsafe(method_family = none)]
115        pub fn setRecognitionLevel(&self, recognition_level: VNRequestTextRecognitionLevel);
116
117        /// Determines whether language correction should be applied during the recognition process. Disabling this will return the raw recognition results providing performance benefits but less accurate results.
118        #[unsafe(method(usesLanguageCorrection))]
119        #[unsafe(method_family = none)]
120        pub fn usesLanguageCorrection(&self) -> bool;
121
122        /// Setter for [`usesLanguageCorrection`][Self::usesLanguageCorrection].
123        #[unsafe(method(setUsesLanguageCorrection:))]
124        #[unsafe(method_family = none)]
125        pub fn setUsesLanguageCorrection(&self, uses_language_correction: bool);
126
127        /// Language detection will try to automatically identify the script/langauge during the detection and use the appropiate model for recognition and language correction. This can be particularly helpful, if the nature of the content is unkown and with this flag being set it will for instance determine if text is latin vs chinese so you don't have to pick the language model in the first case. But as the language correction cannot always guarantee the correct detection, it is advisable to set the languages, if you have domain knowledge of what language to expect. The default value is NO. Also note that this feature is only available since VNRecognizeTextRequestRevision3 and is a no-op before that.
128        #[unsafe(method(automaticallyDetectsLanguage))]
129        #[unsafe(method_family = none)]
130        pub fn automaticallyDetectsLanguage(&self) -> bool;
131
132        /// Setter for [`automaticallyDetectsLanguage`][Self::automaticallyDetectsLanguage].
133        #[unsafe(method(setAutomaticallyDetectsLanguage:))]
134        #[unsafe(method_family = none)]
135        pub fn setAutomaticallyDetectsLanguage(&self, automatically_detects_language: bool);
136
137        #[unsafe(method(minimumTextHeight))]
138        #[unsafe(method_family = none)]
139        pub fn minimumTextHeight(&self) -> c_float;
140
141        /// Setter for [`minimumTextHeight`][Self::minimumTextHeight].
142        #[unsafe(method(setMinimumTextHeight:))]
143        #[unsafe(method_family = none)]
144        pub fn setMinimumTextHeight(&self, minimum_text_height: c_float);
145
146        #[cfg(feature = "VNObservation")]
147        /// VNRecognizedTextObservation results.
148        #[unsafe(method(results))]
149        #[unsafe(method_family = none)]
150        pub fn results(&self) -> Option<Retained<NSArray<VNRecognizedTextObservation>>>;
151    );
152}
153
154/// Methods declared on superclass `VNRequest`.
155#[cfg(feature = "VNRequest")]
156impl VNRecognizeTextRequest {
157    extern_methods!(
158        /// Creates a new VNRequest with no completion handler.
159        #[unsafe(method(init))]
160        #[unsafe(method_family = init)]
161        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
162
163        #[cfg(feature = "block2")]
164        /// Creates a new VNRequest with an optional completion handler.
165        ///
166        ///
167        /// Parameter `completionHandler`: The block to be invoked after the request has completed its processing. The completion handler gets executed on the same dispatch queue as the request being executed.
168        #[unsafe(method(initWithCompletionHandler:))]
169        #[unsafe(method_family = init)]
170        pub unsafe fn initWithCompletionHandler(
171            this: Allocated<Self>,
172            completion_handler: VNRequestCompletionHandler,
173        ) -> Retained<Self>;
174    );
175}
176
177/// Methods declared on superclass `NSObject`.
178#[cfg(feature = "VNRequest")]
179impl VNRecognizeTextRequest {
180    extern_methods!(
181        #[unsafe(method(new))]
182        #[unsafe(method_family = new)]
183        pub fn new() -> Retained<Self>;
184    );
185}
186
187#[cfg(feature = "VNRequest")]
188impl DefaultRetained for VNRecognizeTextRequest {
189    #[inline]
190    fn default_retained() -> Retained<Self> {
191        Self::new()
192    }
193}
194
195/// [Apple's documentation](https://developer.apple.com/documentation/vision/vnrecognizetextrequestrevision1?language=objc)
196pub static VNRecognizeTextRequestRevision1: NSUInteger = 1;
197
198/// [Apple's documentation](https://developer.apple.com/documentation/vision/vnrecognizetextrequestrevision2?language=objc)
199pub static VNRecognizeTextRequestRevision2: NSUInteger = 2;
200
201/// [Apple's documentation](https://developer.apple.com/documentation/vision/vnrecognizetextrequestrevision3?language=objc)
202pub static VNRecognizeTextRequestRevision3: NSUInteger = 3;
objc2_vision/generated/VNRecognizeTextRequest.rs

objc2_vision/generated/
VNRecognizeTextRequest.rs
