#[non_exhaustive]pub struct Address {Show 16 fields
pub label: Option<String>,
pub country: Option<Country>,
pub region: Option<Region>,
pub sub_region: Option<SubRegion>,
pub locality: Option<String>,
pub district: Option<String>,
pub sub_district: Option<String>,
pub postal_code: Option<String>,
pub block: Option<String>,
pub sub_block: Option<String>,
pub intersection: Option<Vec<String>>,
pub street: Option<String>,
pub street_components: Option<Vec<StreetComponents>>,
pub address_number: Option<String>,
pub building: Option<String>,
pub secondary_address_components: Option<Vec<SecondaryAddressComponent>>,
}
Expand description
The place address.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.label: Option<String>
Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
country: Option<Country>
The country component of the address.
region: Option<Region>
The region or state results should be present in.
Example: North Rhine-Westphalia
.
sub_region: Option<SubRegion>
The sub-region or county for which results should be present in.
locality: Option<String>
The city or locality of the address.
Example: Vancouver
.
district: Option<String>
The district or division of a locality associated with this address.
sub_district: Option<String>
A subdivision of a district.
Example: Minden-Lübbecke
.
postal_code: 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.
block: Option<String>
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
sub_block: Option<String>
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
intersection: Option<Vec<String>>
Name of the streets in the intersection.
Example: \["Friedrichstraße","Unter den Linden"\]
street: Option<String>
The name of the street results should be present in.
street_components: Option<Vec<StreetComponents>>
Components of the street.
Example: Younge from the "Younge street".
address_number: Option<String>
The number that identifies an address within a street.
building: Option<String>
The name of the building at the address.
secondary_address_components: 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.
Implementations§
Source§impl Address
impl Address
Sourcepub fn label(&self) -> Option<&str>
pub fn label(&self) -> Option<&str>
Assembled address value built out of the address components, according to the regional postal rules. This is the correctly formatted address.
Sourcepub fn region(&self) -> Option<&Region>
pub fn region(&self) -> Option<&Region>
The region or state results should be present in.
Example: North Rhine-Westphalia
.
Sourcepub fn sub_region(&self) -> Option<&SubRegion>
pub fn sub_region(&self) -> Option<&SubRegion>
The sub-region or county for which results should be present in.
Sourcepub fn locality(&self) -> Option<&str>
pub fn locality(&self) -> Option<&str>
The city or locality of the address.
Example: Vancouver
.
Sourcepub fn district(&self) -> Option<&str>
pub fn district(&self) -> Option<&str>
The district or division of a locality associated with this address.
Sourcepub fn sub_district(&self) -> Option<&str>
pub fn sub_district(&self) -> Option<&str>
A subdivision of a district.
Example: Minden-Lübbecke
.
Sourcepub fn postal_code(&self) -> Option<&str>
pub fn postal_code(&self) -> Option<&str>
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) -> Option<&str>
pub fn block(&self) -> Option<&str>
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
Sourcepub fn sub_block(&self) -> Option<&str>
pub fn sub_block(&self) -> Option<&str>
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
Sourcepub fn intersection(&self) -> &[String]
pub fn intersection(&self) -> &[String]
Name of the streets in the intersection.
Example: \["Friedrichstraße","Unter den Linden"\]
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .intersection.is_none()
.
Sourcepub fn street_components(&self) -> &[StreetComponents]
pub fn street_components(&self) -> &[StreetComponents]
Components of the street.
Example: Younge from the "Younge street".
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .street_components.is_none()
.
Sourcepub fn address_number(&self) -> Option<&str>
pub fn address_number(&self) -> Option<&str>
The number that identifies an address within a street.
Sourcepub fn secondary_address_components(&self) -> &[SecondaryAddressComponent]
pub fn secondary_address_components(&self) -> &[SecondaryAddressComponent]
Components that correspond to secondary identifiers on an Address. Secondary address components include information such as Suite or Unit Number, Building, or Floor.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .secondary_address_components.is_none()
.
Trait Implementations§
impl StructuralPartialEq for Address
Auto Trait Implementations§
impl Freeze for Address
impl RefUnwindSafe for Address
impl Send for Address
impl Sync for Address
impl Unpin for Address
impl UnwindSafe for Address
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);