#[non_exhaustive]pub struct AutocompleteAddressHighlights {Show 14 fields
pub label: Option<Vec<Highlight>>,
pub country: Option<CountryHighlights>,
pub region: Option<RegionHighlights>,
pub sub_region: Option<SubRegionHighlights>,
pub locality: Option<Vec<Highlight>>,
pub district: Option<Vec<Highlight>>,
pub sub_district: Option<Vec<Highlight>>,
pub street: Option<Vec<Highlight>>,
pub block: Option<Vec<Highlight>>,
pub sub_block: Option<Vec<Highlight>>,
pub intersection: Option<Vec<Vec<Highlight>>>,
pub postal_code: Option<Vec<Highlight>>,
pub address_number: Option<Vec<Highlight>>,
pub building: Option<Vec<Highlight>>,
}
Expand description
Describes how the parts of the response element matched the input query by returning the sections of the response which matched to input query terms.
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<Vec<Highlight>>
Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
country: Option<CountryHighlights>
The alpha-2 or alpha-3 character code for the country that the results will be present in.
region: Option<RegionHighlights>
The region or state results should be to be present in.
Example: North Rhine-Westphalia
.
sub_region: Option<SubRegionHighlights>
The sub-region or county for which results should be present in.
locality: Option<Vec<Highlight>>
The city or locality results should be present in.
Example: Vancouver
.
district: Option<Vec<Highlight>>
The district or division of a city the results should be present in.
sub_district: Option<Vec<Highlight>>
Indicates the starting and ending index of the title in the text query that match the found title.
street: Option<Vec<Highlight>>
The name of the street results should be present in.
block: Option<Vec<Highlight>>
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
sub_block: Option<Vec<Highlight>>
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
intersection: Option<Vec<Vec<Highlight>>>
Name of the streets in the intersection. For example: e.g. \["Friedrichstraße","Unter den Linden"\]
postal_code: Option<Vec<Highlight>>
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.
address_number: Option<Vec<Highlight>>
The house number or address results should have.
building: Option<Vec<Highlight>>
The name of the building at the address.
Implementations§
Source§impl AutocompleteAddressHighlights
impl AutocompleteAddressHighlights
Sourcepub fn label(&self) -> &[Highlight]
pub fn label(&self) -> &[Highlight]
Indicates the starting and ending indexes for result items where they are identified to match the input query. This should be used to provide emphasis to output display to make selecting the correct result from a list easier for end users.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .label.is_none()
.
Sourcepub fn country(&self) -> Option<&CountryHighlights>
pub fn country(&self) -> Option<&CountryHighlights>
The alpha-2 or alpha-3 character code for the country that the results will be present in.
Sourcepub fn region(&self) -> Option<&RegionHighlights>
pub fn region(&self) -> Option<&RegionHighlights>
The region or state results should be to be present in.
Example: North Rhine-Westphalia
.
Sourcepub fn sub_region(&self) -> Option<&SubRegionHighlights>
pub fn sub_region(&self) -> Option<&SubRegionHighlights>
The sub-region or county for which results should be present in.
Sourcepub fn locality(&self) -> &[Highlight]
pub fn locality(&self) -> &[Highlight]
The city or locality results should be present in.
Example: Vancouver
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .locality.is_none()
.
Sourcepub fn district(&self) -> &[Highlight]
pub fn district(&self) -> &[Highlight]
The district or division of a city the results should be present in.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .district.is_none()
.
Sourcepub fn sub_district(&self) -> &[Highlight]
pub fn sub_district(&self) -> &[Highlight]
Indicates the starting and ending index of the title in the text query that match the found title.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sub_district.is_none()
.
Sourcepub fn street(&self) -> &[Highlight]
pub fn street(&self) -> &[Highlight]
The name of the street results should be present in.
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.is_none()
.
Sourcepub fn block(&self) -> &[Highlight]
pub fn block(&self) -> &[Highlight]
Name of the block.
Example: Sunny Mansion 203 block: 2 Chome
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .block.is_none()
.
Sourcepub fn sub_block(&self) -> &[Highlight]
pub fn sub_block(&self) -> &[Highlight]
Name of sub-block.
Example: Sunny Mansion 203 sub-block: 4
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sub_block.is_none()
.
Sourcepub fn intersection(&self) -> &[Vec<Highlight>]
pub fn intersection(&self) -> &[Vec<Highlight>]
Name of the streets in the intersection. For example: e.g. \["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 postal_code(&self) -> &[Highlight]
pub fn postal_code(&self) -> &[Highlight]
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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .postal_code.is_none()
.
Sourcepub fn address_number(&self) -> &[Highlight]
pub fn address_number(&self) -> &[Highlight]
The house number or address results should have.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .address_number.is_none()
.
Source§impl AutocompleteAddressHighlights
impl AutocompleteAddressHighlights
Sourcepub fn builder() -> AutocompleteAddressHighlightsBuilder
pub fn builder() -> AutocompleteAddressHighlightsBuilder
Creates a new builder-style object to manufacture AutocompleteAddressHighlights
.
Trait Implementations§
Source§impl Clone for AutocompleteAddressHighlights
impl Clone for AutocompleteAddressHighlights
Source§fn clone(&self) -> AutocompleteAddressHighlights
fn clone(&self) -> AutocompleteAddressHighlights
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for AutocompleteAddressHighlights
impl PartialEq for AutocompleteAddressHighlights
Source§fn eq(&self, other: &AutocompleteAddressHighlights) -> bool
fn eq(&self, other: &AutocompleteAddressHighlights) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AutocompleteAddressHighlights
Auto Trait Implementations§
impl Freeze for AutocompleteAddressHighlights
impl RefUnwindSafe for AutocompleteAddressHighlights
impl Send for AutocompleteAddressHighlights
impl Sync for AutocompleteAddressHighlights
impl Unpin for AutocompleteAddressHighlights
impl UnwindSafe for AutocompleteAddressHighlights
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);