#[non_exhaustive]pub struct IdentityDocumentBuilder { /* private fields */ }
Expand description
A builder for IdentityDocument
.
Implementations§
Source§impl IdentityDocumentBuilder
impl IdentityDocumentBuilder
Sourcepub fn document_index(self, input: i32) -> Self
pub fn document_index(self, input: i32) -> Self
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
Sourcepub fn set_document_index(self, input: Option<i32>) -> Self
pub fn set_document_index(self, input: Option<i32>) -> Self
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
Sourcepub fn get_document_index(&self) -> &Option<i32>
pub fn get_document_index(&self) -> &Option<i32>
Denotes the placement of a document in the IdentityDocument list. The first document is marked 1, the second 2 and so on.
Sourcepub fn identity_document_fields(self, input: IdentityDocumentField) -> Self
pub fn identity_document_fields(self, input: IdentityDocumentField) -> Self
Appends an item to identity_document_fields
.
To override the contents of this collection use set_identity_document_fields
.
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
Sourcepub fn set_identity_document_fields(
self,
input: Option<Vec<IdentityDocumentField>>,
) -> Self
pub fn set_identity_document_fields( self, input: Option<Vec<IdentityDocumentField>>, ) -> Self
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
Sourcepub fn get_identity_document_fields(
&self,
) -> &Option<Vec<IdentityDocumentField>>
pub fn get_identity_document_fields( &self, ) -> &Option<Vec<IdentityDocumentField>>
The structure used to record information extracted from identity documents. Contains both normalized field and value of the extracted text.
Sourcepub fn blocks(self, input: Block) -> Self
pub fn blocks(self, input: Block) -> Self
Appends an item to blocks
.
To override the contents of this collection use set_blocks
.
Individual word recognition, as returned by document detection.
Sourcepub fn set_blocks(self, input: Option<Vec<Block>>) -> Self
pub fn set_blocks(self, input: Option<Vec<Block>>) -> Self
Individual word recognition, as returned by document detection.
Sourcepub fn get_blocks(&self) -> &Option<Vec<Block>>
pub fn get_blocks(&self) -> &Option<Vec<Block>>
Individual word recognition, as returned by document detection.
Sourcepub fn build(self) -> IdentityDocument
pub fn build(self) -> IdentityDocument
Consumes the builder and constructs a IdentityDocument
.
Trait Implementations§
Source§impl Clone for IdentityDocumentBuilder
impl Clone for IdentityDocumentBuilder
Source§fn clone(&self) -> IdentityDocumentBuilder
fn clone(&self) -> IdentityDocumentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for IdentityDocumentBuilder
impl Debug for IdentityDocumentBuilder
Source§impl Default for IdentityDocumentBuilder
impl Default for IdentityDocumentBuilder
Source§fn default() -> IdentityDocumentBuilder
fn default() -> IdentityDocumentBuilder
Source§impl PartialEq for IdentityDocumentBuilder
impl PartialEq for IdentityDocumentBuilder
impl StructuralPartialEq for IdentityDocumentBuilder
Auto Trait Implementations§
impl Freeze for IdentityDocumentBuilder
impl RefUnwindSafe for IdentityDocumentBuilder
impl Send for IdentityDocumentBuilder
impl Sync for IdentityDocumentBuilder
impl Unpin for IdentityDocumentBuilder
impl UnwindSafe for IdentityDocumentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);