1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

//! Simple library providing asynchronous methods for tesseract api.
//!
//! Main function `recognize_doc` allows to recognize images and if it is necessary save data to a file. This function takes five parameters:
//! 1. save_path: Option<&str> - path for saving a doc. If path is None, then file will be saved to a project dir.
//! 2. doc_name: Option<&str> - name of a doc where recognized information will be saved. Default value - data.txt
//! 3. image_array: Vec<&str> - vector which contains a paths to available images.
//! 4. output_type: &str - a str which contains output type value. So far, only 4 types available (txt, tsv, hocr)
//! 5. save_doc: Option<bool> - bool flag to save document.
//! # Examples
//!
//! ```rust, no_run
//! use rusttesserast::tess_lib::TesseractApi;
//!
//! #[tokio::main]
//! async fn main() {
//!     let mut tesseract_base = TesseractApi::new(Some(TesseractApi{dpi: 3, psm:3, ..Default::default()}), Some(String::from("/usr/local/share/tessdata").as_str()), Some(String::from("eng").as_str())).unwrap();
//!     let image_array = vec!["/workspaces/rusttesserast/tests/test_img.png", "/workspaces/rusttesserast/tests/test_img.png"];
//!     let test = tesseract_base.recognize_doc(None, None, image_array, "txt", None).await;
//! }
//! ```
//!
//! ```rust, no_run
//! use rusttesserast::tess_lib::TesseractApi;
//!
//! #[tokio::main]
//! async fn main() {
//!     let mut tesseract_base = TesseractApi::new(Some(TesseractApi{dpi: 3, psm:3, ..Default::default()}), Some(String::from("/usr/local/share/tessdata").as_str()), Some(String::from("eng").as_str())).unwrap();
//!     let image_array = vec!["/workspaces/rusttesserast/tests/test_img.png", "/workspaces/rusttesserast/tests/test_img.png"];
//!     let test = tesseract_base.recognize_doc(Some(String::from("test/save/path").as_str()), Some(String::from("test_data_file.txt").as_str()), image_array, "tsv", Some(true)).await;
//! }
//!
#![doc(
    html_logo_url = "https://github.com/spectrtrec/rusttesserast/blob/main/logo.png",
    html_favicon_url = "https://github.com/spectrtrec/rusttesserast/blob/main/logo.svg",
    html_root_url = "https://docs.rs/rusttesserast/0.0.2"
)]
pub mod constanst;
pub mod file_types;
pub mod errors;
pub mod tess_lib;
pub mod utils;