Struct aws_sdk_textract::types::Adapter

#[non_exhaustive]
pub struct Adapter {
    pub adapter_id: String,
    pub pages: Option<Vec<String>>,
    pub version: String,
}

An adapter selected for use when analyzing documents. Contains an adapter ID and a version number. Contains information on pages selected for analysis when analyzing documents asychronously.

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.

adapter_id: String

A unique identifier for the adapter resource.

pages: Option<Vec<String>>

Pages is a parameter that the user inputs to specify which pages to apply an adapter 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.

version: String

A string that identifies the version of the adapter.

Implementations

impl Adapter

pub fn adapter_id(&self) -> &str

A unique identifier for the adapter resource.

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

Pages is a parameter that the user inputs to specify which pages to apply an adapter 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().

pub fn version(&self) -> &str

A string that identifies the version of the adapter.

impl Adapter

pub fn builder() -> AdapterBuilder

Creates a new builder-style object to manufacture Adapter.

Trait Implementations

impl Clone for Adapter

fn clone(&self) -> Adapter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Adapter

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

Formats the value using the given formatter.

impl PartialEq for Adapter

fn eq(&self, other: &Adapter) -> 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 StructuralPartialEq for Adapter