Struct Query

#[non_exhaustive]
pub struct Query {
    pub text: String,
    pub alias: Option<String>,
    pub pages: Option<Vec<String>>,
}

Each query contains the question you want to ask in the Text and the alias you want to associate.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

alias: Option<String>

Alias attached to the query, for ease of location.

pages: Option<Vec<String>>

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to \["1"\] by default.

• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

• When using * to indicate all pages, it must be the only element in the list.

• You can use page intervals, such as \[“1-3”, “1-1”, “4-*”\]. Where * indicates last page of document.

• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

Implementations

impl Query

pub fn text(&self) -> &str

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

pub fn alias(&self) -> Option<&str>

Alias attached to the query, for ease of location.

pub fn pages(&self) -> &[String]

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to \["1"\] by default.

• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.

• When using * to indicate all pages, it must be the only element in the list.

• You can use page intervals, such as \[“1-3”, “1-1”, “4-*”\]. Where * indicates last page of document.

• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pages.is_none().

impl Query

pub fn builder() -> QueryBuilder

Creates a new builder-style object to manufacture Query.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Query

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

Formats the value using the given formatter.

impl PartialEq for Query

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Query