Struct AdapterBuilder

#[non_exhaustive]
pub struct AdapterBuilder { /* private fields */ }

A builder for Adapter.

Implementations

impl AdapterBuilder

pub fn adapter_id(self, input: impl Into<String>) -> Self

A unique identifier for the adapter resource.

This field is required.

pub fn set_adapter_id(self, input: Option<String>) -> Self

A unique identifier for the adapter resource.

pub fn get_adapter_id(&self) -> &Option<String>

A unique identifier for the adapter resource.

pub fn pages(self, input: impl Into<String>) -> Self

Appends an item to pages.

To override the contents of this collection use set_pages.

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.

pub fn set_pages(self, input: Option<Vec<String>>) -> Self

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.

pub fn get_pages(&self) -> &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.

pub fn version(self, input: impl Into<String>) -> Self

A string that identifies the version of the adapter.

This field is required.

pub fn set_version(self, input: Option<String>) -> Self

A string that identifies the version of the adapter.

pub fn get_version(&self) -> &Option<String>

A string that identifies the version of the adapter.

pub fn build(self) -> Result<Adapter, BuildError>

Consumes the builder and constructs a Adapter. This method will fail if any of the following fields are not set:

• adapter_id
• version

Trait Implementations

impl Clone for AdapterBuilder

fn clone(&self) -> AdapterBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdapterBuilder

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

Formats the value using the given formatter.

impl Default for AdapterBuilder

fn default() -> AdapterBuilder

Returns the “default value” for a type.

impl PartialEq for AdapterBuilder

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