Struct objc2_vision::VNRecognizeTextRequest

#[repr(C)]
pub struct VNRecognizeTextRequest { /* private fields */ }

Available on crate features VNRecognizeTextRequest and VNRequest only.

Implementations

impl VNRecognizeTextRequest

pub unsafe fn supportedRecognitionLanguagesForTextRecognitionLevel_revision_error( recognition_level: VNRequestTextRecognitionLevel, request_revision: NSUInteger ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>

👎Deprecated

pub unsafe fn supportedRecognitionLanguagesAndReturnError( &self ) -> Result<Retained<NSArray<NSString>>, Retained<NSError>>

pub unsafe fn recognitionLanguages(&self) -> Retained<NSArray<NSString>>

pub unsafe fn setRecognitionLanguages( &self, recognition_languages: &NSArray<NSString> )

pub unsafe fn customWords(&self) -> Retained<NSArray<NSString>>

pub unsafe fn setCustomWords(&self, custom_words: &NSArray<NSString>)

pub unsafe fn recognitionLevel(&self) -> VNRequestTextRecognitionLevel

pub unsafe fn setRecognitionLevel( &self, recognition_level: VNRequestTextRecognitionLevel )

pub unsafe fn usesLanguageCorrection(&self) -> bool

pub unsafe fn setUsesLanguageCorrection(&self, uses_language_correction: bool)

pub unsafe fn automaticallyDetectsLanguage(&self) -> bool

pub unsafe fn setAutomaticallyDetectsLanguage( &self, automatically_detects_language: bool )

pub unsafe fn minimumTextHeight(&self) -> c_float

pub unsafe fn setMinimumTextHeight(&self, minimum_text_height: c_float)

pub unsafe fn results( &self ) -> Option<Retained<NSArray<VNRecognizedTextObservation>>>

Available on crate feature VNObservation only.

impl VNRecognizeTextRequest

Methods declared on superclass VNRequest

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn initWithCompletionHandler( this: Allocated<Self>, completion_handler: VNRequestCompletionHandler ) -> Retained<Self>

Available on crate feature block2 only.

impl VNRecognizeTextRequest

Methods declared on superclass NSObject

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = VNImageBasedRequest>

pub unsafe fn regionOfInterest(&self) -> CGRect

pub unsafe fn setRegionOfInterest(&self, region_of_interest: CGRect)

Methods from Deref<Target = VNRequest>

pub unsafe fn preferBackgroundProcessing(&self) -> bool

pub unsafe fn setPreferBackgroundProcessing( &self, prefer_background_processing: bool )

pub unsafe fn usesCPUOnly(&self) -> bool

👎Deprecated

pub unsafe fn setUsesCPUOnly(&self, uses_cpu_only: bool)

👎Deprecated

pub unsafe fn results(&self) -> Option<Retained<NSArray<VNObservation>>>

Available on crate feature VNObservation only.

pub unsafe fn completionHandler(&self) -> VNRequestCompletionHandler

Available on crate feature block2 only.

pub unsafe fn revision(&self) -> NSUInteger

pub unsafe fn setRevision(&self, revision: NSUInteger)

pub unsafe fn cancel(&self)

pub unsafe fn supportedComputeStageDevicesAndReturnError( &self ) -> Result<Retained<NSDictionary<VNComputeStage, NSArray<ProtocolObject<dyn MLComputeDeviceProtocol>>>>, Retained<NSError>>

Available on crate features VNTypes and objc2-core-ml only.

pub unsafe fn computeDeviceForComputeStage( &self, compute_stage: &VNComputeStage ) -> Option<Retained<ProtocolObject<dyn MLComputeDeviceProtocol>>>

Available on crate features VNTypes and objc2-core-ml only.

pub unsafe fn setComputeDevice_forComputeStage( &self, compute_device: Option<&ProtocolObject<dyn MLComputeDeviceProtocol>>, compute_stage: &VNComputeStage )

Available on crate features VNTypes and objc2-core-ml only.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Trait Implementations

impl AsMut<AnyObject> for VNRecognizeTextRequest

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for VNRecognizeTextRequest

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<VNImageBasedRequest> for VNRecognizeTextRequest

fn as_mut(&mut self) -> &mut VNImageBasedRequest

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

impl AsMut<VNRecognizeTextRequest> for VNRecognizeTextRequest

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<VNRequest> for VNRecognizeTextRequest

fn as_mut(&mut self) -> &mut VNRequest

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

impl AsRef<AnyObject> for VNRecognizeTextRequest

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for VNRecognizeTextRequest

fn as_ref(&self) -> &NSObject

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

impl AsRef<VNImageBasedRequest> for VNRecognizeTextRequest

fn as_ref(&self) -> &VNImageBasedRequest

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

impl AsRef<VNRecognizeTextRequest> for VNRecognizeTextRequest

fn as_ref(&self) -> &Self

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

impl AsRef<VNRequest> for VNRecognizeTextRequest

fn as_ref(&self) -> &VNRequest

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

impl Borrow<AnyObject> for VNRecognizeTextRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for VNRecognizeTextRequest

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<VNImageBasedRequest> for VNRecognizeTextRequest

fn borrow(&self) -> &VNImageBasedRequest

Immutably borrows from an owned value.

impl Borrow<VNRequest> for VNRecognizeTextRequest

fn borrow(&self) -> &VNRequest

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for VNRecognizeTextRequest

fn borrow_mut(&mut self) -> &mut AnyObject

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for VNRecognizeTextRequest

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl BorrowMut<VNImageBasedRequest> for VNRecognizeTextRequest

fn borrow_mut(&mut self) -> &mut VNImageBasedRequest

Mutably borrows from an owned value.

impl BorrowMut<VNRequest> for VNRecognizeTextRequest

fn borrow_mut(&mut self) -> &mut VNRequest

Mutably borrows from an owned value.

impl ClassType for VNRecognizeTextRequest

type Super = VNImageBasedRequest

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "VNRecognizeTextRequest"

The name of the Objective-C class that this type represents.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for VNRecognizeTextRequest

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

Formats the value using the given formatter.

impl Deref for VNRecognizeTextRequest

type Target = VNImageBasedRequest

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for VNRecognizeTextRequest

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Hash for VNRecognizeTextRequest

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 NSCopying for VNRecognizeTextRequest

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for VNRecognizeTextRequest

fn isEqual(&self, other: &AnyObject) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

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

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for VNRecognizeTextRequest

fn eq(&self, other: &VNRecognizeTextRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for VNRecognizeTextRequest

const ENCODING_REF: Encoding = <VNImageBasedRequest as ::objc2::RefEncode>::ENCODING_REF

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

impl VNRequestProgressProviding for VNRecognizeTextRequest

unsafe fn progressHandler(&self) -> VNRequestProgressHandler

where Self: Sized + Message,

Available on crate feature block2 only.

unsafe fn setProgressHandler(&self, progress_handler: VNRequestProgressHandler)

where Self: Sized + Message,

Available on crate feature block2 only.

unsafe fn indeterminate(&self) -> bool

where Self: Sized + Message,

impl Eq for VNRecognizeTextRequest

impl Message for VNRecognizeTextRequest

impl StructuralPartialEq for VNRecognizeTextRequest