Skip to main content

TextRecognizer

Struct TextRecognizer 

Source
pub struct TextRecognizer { /* private fields */ }
Available on crate feature recognize_text only.
Expand description

OCR engine.

§Examples

use apple_vision::recognize_text::{TextRecognizer, RecognitionLevel};

let recognizer = TextRecognizer::new()
    .with_recognition_level(RecognitionLevel::Accurate)
    .with_language_correction(true);
let observations = recognizer.recognize_in_path("/tmp/screenshot.png")?;
for obs in &observations {
    println!("{:.2} {:?}: {}", obs.confidence, obs.bounding_box, obs.text);
}

Implementations§

Source§

impl TextRecognizer

Source

pub const fn new() -> Self

Construct with the Vision defaults: accurate mode + language correction enabled.

Source

pub const fn with_recognition_level(self, level: RecognitionLevel) -> Self

Source

pub const fn with_language_correction(self, enabled: bool) -> Self

Source

pub fn recognize_in_path( &self, path: impl AsRef<Path>, ) -> Result<Vec<RecognizedText>, VisionError>

Recognise text in the image at path. Supports any format CoreGraphics’ ImageIO can read (PNG, JPEG, HEIC, TIFF, …).

Returns observations in Vision’s natural ordering (top-down, left-to-right after layout analysis).

§Errors

Returns VisionError::InvalidArgument if path contains an interior NUL byte, VisionError::ImageLoadFailed if the image can’t be read, or VisionError::RequestFailed if Vision rejects the request.

Source

pub fn recognize_in_pixel_buffer( &self, pixel_buffer: &CVPixelBuffer, ) -> Result<Vec<RecognizedText>, VisionError>

Recognise text in a CVPixelBuffer directly, without a PNG round-trip. This is the zero-copy path for live capture pipelines (screencapturekit / videotoolbox decoder / AVCaptureSession).

§Errors

Returns VisionError::RequestFailed if Vision rejects the buffer (e.g. unsupported pixel format).

Trait Implementations§

Source§

impl Clone for TextRecognizer

Source§

fn clone(&self) -> TextRecognizer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextRecognizer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextRecognizer

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.