#[non_exhaustive]pub struct AddressBuilder { /* private fields */ }
Expand description
A builder for Address
.
Implementations§
Source§impl AddressBuilder
impl AddressBuilder
Sourcepub fn label(self, input: impl Into<String>) -> Self
pub fn label(self, input: impl Into<String>) -> Self
Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
Sourcepub fn set_label(self, input: Option<String>) -> Self
pub fn set_label(self, input: Option<String>) -> Self
Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
Sourcepub fn get_label(&self) -> &Option<String>
pub fn get_label(&self) -> &Option<String>
Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
Sourcepub fn set_country(self, input: Option<Country>) -> Self
pub fn set_country(self, input: Option<Country>) -> Self
The country component of the address.
Sourcepub fn get_country(&self) -> &Option<Country>
pub fn get_country(&self) -> &Option<Country>
The country component of the address.
Sourcepub fn region(self, input: Region) -> Self
pub fn region(self, input: Region) -> Self
The region or state results should be present in.
Example: North Rhine-Westphalia
.
Sourcepub fn set_region(self, input: Option<Region>) -> Self
pub fn set_region(self, input: Option<Region>) -> Self
The region or state results should be present in.
Example: North Rhine-Westphalia
.
Sourcepub fn get_region(&self) -> &Option<Region>
pub fn get_region(&self) -> &Option<Region>
The region or state results should be present in.
Example: North Rhine-Westphalia
.
Sourcepub fn sub_region(self, input: SubRegion) -> Self
pub fn sub_region(self, input: SubRegion) -> Self
The sub-region or county for which results should be present in.
Sourcepub fn set_sub_region(self, input: Option<SubRegion>) -> Self
pub fn set_sub_region(self, input: Option<SubRegion>) -> Self
The sub-region or county for which results should be present in.
Sourcepub fn get_sub_region(&self) -> &Option<SubRegion>
pub fn get_sub_region(&self) -> &Option<SubRegion>
The sub-region or county for which results should be present in.
Sourcepub fn locality(self, input: impl Into<String>) -> Self
pub fn locality(self, input: impl Into<String>) -> Self
The city or locality of the address.
Example: Vancouver
.
Sourcepub fn set_locality(self, input: Option<String>) -> Self
pub fn set_locality(self, input: Option<String>) -> Self
The city or locality of the address.
Example: Vancouver
.
Sourcepub fn get_locality(&self) -> &Option<String>
pub fn get_locality(&self) -> &Option<String>
The city or locality of the address.
Example: Vancouver
.
Sourcepub fn district(self, input: impl Into<String>) -> Self
pub fn district(self, input: impl Into<String>) -> Self
The district or division of a locality associated with this address.
Sourcepub fn set_district(self, input: Option<String>) -> Self
pub fn set_district(self, input: Option<String>) -> Self
The district or division of a locality associated with this address.
Sourcepub fn get_district(&self) -> &Option<String>
pub fn get_district(&self) -> &Option<String>
The district or division of a locality associated with this address.
Sourcepub fn sub_district(self, input: impl Into<String>) -> Self
pub fn sub_district(self, input: impl Into<String>) -> Self
A subdivision of a district.
Example: Minden-Lübbecke
.
Sourcepub fn set_sub_district(self, input: Option<String>) -> Self
pub fn set_sub_district(self, input: Option<String>) -> Self
A subdivision of a district.
Example: Minden-Lübbecke
.
Sourcepub fn get_sub_district(&self) -> &Option<String>
pub fn get_sub_district(&self) -> &Option<String>
A subdivision of a district.
Example: Minden-Lübbecke
.
Sourcepub fn postal_code(self, input: impl Into<String>) -> Self
pub fn postal_code(self, input: impl Into<String>) -> Self
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
Sourcepub fn set_postal_code(self, input: Option<String>) -> Self
pub fn set_postal_code(self, input: Option<String>) -> Self
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
Sourcepub fn get_postal_code(&self) -> &Option<String>
pub fn get_postal_code(&self) -> &Option<String>
An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code, for which the result should possess.
Sourcepub fn block(self, input: impl Into<String>) -> Self
pub fn block(self, input: impl Into<String>) -> Self
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Sourcepub fn set_block(self, input: Option<String>) -> Self
pub fn set_block(self, input: Option<String>) -> Self
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Sourcepub fn get_block(&self) -> &Option<String>
pub fn get_block(&self) -> &Option<String>
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Sourcepub fn sub_block(self, input: impl Into<String>) -> Self
pub fn sub_block(self, input: impl Into<String>) -> Self
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Sourcepub fn set_sub_block(self, input: Option<String>) -> Self
pub fn set_sub_block(self, input: Option<String>) -> Self
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Sourcepub fn get_sub_block(&self) -> &Option<String>
pub fn get_sub_block(&self) -> &Option<String>
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Sourcepub fn intersection(self, input: impl Into<String>) -> Self
pub fn intersection(self, input: impl Into<String>) -> Self
Appends an item to intersection
.
To override the contents of this collection use set_intersection
.
Name of the streets in the intersection.
Example: \["Friedrichstraße","Unter den Linden"\]
Sourcepub fn set_intersection(self, input: Option<Vec<String>>) -> Self
pub fn set_intersection(self, input: Option<Vec<String>>) -> Self
Name of the streets in the intersection.
Example: \["Friedrichstraße","Unter den Linden"\]
Sourcepub fn get_intersection(&self) -> &Option<Vec<String>>
pub fn get_intersection(&self) -> &Option<Vec<String>>
Name of the streets in the intersection.
Example: \["Friedrichstraße","Unter den Linden"\]
Sourcepub fn street(self, input: impl Into<String>) -> Self
pub fn street(self, input: impl Into<String>) -> Self
The name of the street results should be present in.
Sourcepub fn set_street(self, input: Option<String>) -> Self
pub fn set_street(self, input: Option<String>) -> Self
The name of the street results should be present in.
Sourcepub fn get_street(&self) -> &Option<String>
pub fn get_street(&self) -> &Option<String>
The name of the street results should be present in.
Sourcepub fn street_components(self, input: StreetComponents) -> Self
pub fn street_components(self, input: StreetComponents) -> Self
Appends an item to street_components
.
To override the contents of this collection use set_street_components
.
Components of the street.
Example: Younge from the "Younge street".
Sourcepub fn set_street_components(self, input: Option<Vec<StreetComponents>>) -> Self
pub fn set_street_components(self, input: Option<Vec<StreetComponents>>) -> Self
Components of the street.
Example: Younge from the "Younge street".
Sourcepub fn get_street_components(&self) -> &Option<Vec<StreetComponents>>
pub fn get_street_components(&self) -> &Option<Vec<StreetComponents>>
Components of the street.
Example: Younge from the "Younge street".
Sourcepub fn address_number(self, input: impl Into<String>) -> Self
pub fn address_number(self, input: impl Into<String>) -> Self
The number that identifies an address within a street.
Sourcepub fn set_address_number(self, input: Option<String>) -> Self
pub fn set_address_number(self, input: Option<String>) -> Self
The number that identifies an address within a street.
Sourcepub fn get_address_number(&self) -> &Option<String>
pub fn get_address_number(&self) -> &Option<String>
The number that identifies an address within a street.
Sourcepub fn building(self, input: impl Into<String>) -> Self
pub fn building(self, input: impl Into<String>) -> Self
The name of the building at the address.
Sourcepub fn set_building(self, input: Option<String>) -> Self
pub fn set_building(self, input: Option<String>) -> Self
The name of the building at the address.
Sourcepub fn get_building(&self) -> &Option<String>
pub fn get_building(&self) -> &Option<String>
The name of the building at the address.
Sourcepub fn secondary_address_components(
self,
input: SecondaryAddressComponent,
) -> Self
pub fn secondary_address_components( self, input: SecondaryAddressComponent, ) -> Self
Appends an item to secondary_address_components
.
To override the contents of this collection use set_secondary_address_components
.
Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
Sourcepub fn set_secondary_address_components(
self,
input: Option<Vec<SecondaryAddressComponent>>,
) -> Self
pub fn set_secondary_address_components( self, input: Option<Vec<SecondaryAddressComponent>>, ) -> Self
Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
Sourcepub fn get_secondary_address_components(
&self,
) -> &Option<Vec<SecondaryAddressComponent>>
pub fn get_secondary_address_components( &self, ) -> &Option<Vec<SecondaryAddressComponent>>
Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
Trait Implementations§
Source§impl Clone for AddressBuilder
impl Clone for AddressBuilder
Source§fn clone(&self) -> AddressBuilder
fn clone(&self) -> AddressBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for AddressBuilder
impl Debug for AddressBuilder
Source§impl Default for AddressBuilder
impl Default for AddressBuilder
Source§fn default() -> AddressBuilder
fn default() -> AddressBuilder
Source§impl PartialEq for AddressBuilder
impl PartialEq for AddressBuilder
impl StructuralPartialEq for AddressBuilder
Auto Trait Implementations§
impl Freeze for AddressBuilder
impl RefUnwindSafe for AddressBuilder
impl Send for AddressBuilder
impl Sync for AddressBuilder
impl Unpin for AddressBuilder
impl UnwindSafe for AddressBuilder
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);