pub struct AutocompleteFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to Autocomplete
.
Autocomplete
completes potential places and addresses as the user types, based on the partial input. The API enhances the efficiency and accuracy of address by completing query based on a few entered keystrokes. It helps you by completing partial queries with valid address completion. Also, the API supports the filtering of results based on geographic location, country, or specific place types, and can be tailored using optional parameters like language and political views.
Implementations§
Source§impl AutocompleteFluentBuilder
impl AutocompleteFluentBuilder
Sourcepub fn as_input(&self) -> &AutocompleteInputBuilder
pub fn as_input(&self) -> &AutocompleteInputBuilder
Access the Autocomplete as a reference.
Sourcepub async fn send(
self,
) -> Result<AutocompleteOutput, SdkError<AutocompleteError, HttpResponse>>
pub async fn send( self, ) -> Result<AutocompleteOutput, SdkError<AutocompleteError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<AutocompleteOutput, AutocompleteError, Self>
pub fn customize( self, ) -> CustomizableOperation<AutocompleteOutput, AutocompleteError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn query_text(self, input: impl Into<String>) -> Self
pub fn query_text(self, input: impl Into<String>) -> Self
The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText
, and QueryID
are mutually exclusive.
Sourcepub fn set_query_text(self, input: Option<String>) -> Self
pub fn set_query_text(self, input: Option<String>) -> Self
The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText
, and QueryID
are mutually exclusive.
Sourcepub fn get_query_text(&self) -> &Option<String>
pub fn get_query_text(&self) -> &Option<String>
The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.
The fields QueryText
, and QueryID
are mutually exclusive.
Sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
An optional limit for the number of results returned in a single call.
Sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
An optional limit for the number of results returned in a single call.
Sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
An optional limit for the number of results returned in a single call.
Sourcepub fn bias_position(self, input: f64) -> Self
pub fn bias_position(self, input: f64) -> Self
Appends an item to BiasPosition
.
To override the contents of this collection use set_bias_position
.
The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in \[lng, lat\]
and in the WSG84 format.
The fields BiasPosition
, FilterBoundingBox
, and FilterCircle
are mutually exclusive.
Sourcepub fn set_bias_position(self, input: Option<Vec<f64>>) -> Self
pub fn set_bias_position(self, input: Option<Vec<f64>>) -> Self
The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in \[lng, lat\]
and in the WSG84 format.
The fields BiasPosition
, FilterBoundingBox
, and FilterCircle
are mutually exclusive.
Sourcepub fn get_bias_position(&self) -> &Option<Vec<f64>>
pub fn get_bias_position(&self) -> &Option<Vec<f64>>
The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in \[lng, lat\]
and in the WSG84 format.
The fields BiasPosition
, FilterBoundingBox
, and FilterCircle
are mutually exclusive.
Sourcepub fn filter(self, input: AutocompleteFilter) -> Self
pub fn filter(self, input: AutocompleteFilter) -> Self
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
Sourcepub fn set_filter(self, input: Option<AutocompleteFilter>) -> Self
pub fn set_filter(self, input: Option<AutocompleteFilter>) -> Self
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
Sourcepub fn get_filter(&self) -> &Option<AutocompleteFilter>
pub fn get_filter(&self) -> &Option<AutocompleteFilter>
A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.
Sourcepub fn postal_code_mode(self, input: PostalCodeMode) -> Self
pub fn postal_code_mode(self, input: PostalCodeMode) -> Self
The PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities
, all cities in that postal code are returned.
Sourcepub fn set_postal_code_mode(self, input: Option<PostalCodeMode>) -> Self
pub fn set_postal_code_mode(self, input: Option<PostalCodeMode>) -> Self
The PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities
, all cities in that postal code are returned.
Sourcepub fn get_postal_code_mode(&self) -> &Option<PostalCodeMode>
pub fn get_postal_code_mode(&self) -> &Option<PostalCodeMode>
The PostalCodeMode
affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities
, all cities in that postal code are returned.
Sourcepub fn additional_features(self, input: AutocompleteAdditionalFeature) -> Self
pub fn additional_features(self, input: AutocompleteAdditionalFeature) -> Self
Appends an item to AdditionalFeatures
.
To override the contents of this collection use set_additional_features
.
A list of optional additional parameters that can be requested for each result.
Sourcepub fn set_additional_features(
self,
input: Option<Vec<AutocompleteAdditionalFeature>>,
) -> Self
pub fn set_additional_features( self, input: Option<Vec<AutocompleteAdditionalFeature>>, ) -> Self
A list of optional additional parameters that can be requested for each result.
Sourcepub fn get_additional_features(
&self,
) -> &Option<Vec<AutocompleteAdditionalFeature>>
pub fn get_additional_features( &self, ) -> &Option<Vec<AutocompleteAdditionalFeature>>
A list of optional additional parameters that can be requested for each result.
Sourcepub fn language(self, input: impl Into<String>) -> Self
pub fn language(self, input: impl Into<String>) -> Self
A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
Sourcepub fn set_language(self, input: Option<String>) -> Self
pub fn set_language(self, input: Option<String>) -> Self
A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
Sourcepub fn get_language(&self) -> &Option<String>
pub fn get_language(&self) -> &Option<String>
A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.
Sourcepub fn political_view(self, input: impl Into<String>) -> Self
pub fn political_view(self, input: impl Into<String>) -> Self
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
Sourcepub fn set_political_view(self, input: Option<String>) -> Self
pub fn set_political_view(self, input: Option<String>) -> Self
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
Sourcepub fn get_political_view(&self) -> &Option<String>
pub fn get_political_view(&self) -> &Option<String>
The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.
The following political views are currently supported:
-
ARG
: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands -
EGY
: Egypt's view on Bir Tawil -
IND
: India's view on Gilgit-Baltistan -
KEN
: Kenya's view on the Ilemi Triangle -
MAR
: Morocco's view on Western Sahara -
RUS
: Russia's view on Crimea -
SDN
: Sudan's view on the Halaib Triangle -
SRB
: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands -
SUR
: Suriname's view on the Courantyne Headwaters and Lawa Headwaters -
SYR
: Syria's view on the Golan Heights -
TUR
: Turkey's view on Cyprus and Northern Cyprus -
TZA
: Tanzania's view on Lake Malawi -
URY
: Uruguay's view on Rincon de Artigas -
VNM
: Vietnam's view on the Paracel Islands and Spratly Islands
Sourcepub fn intended_use(self, input: AutocompleteIntendedUse) -> Self
pub fn intended_use(self, input: AutocompleteIntendedUse) -> Self
Indicates if the results will be stored. Defaults to SingleUse
, if left empty.
Sourcepub fn set_intended_use(self, input: Option<AutocompleteIntendedUse>) -> Self
pub fn set_intended_use(self, input: Option<AutocompleteIntendedUse>) -> Self
Indicates if the results will be stored. Defaults to SingleUse
, if left empty.
Sourcepub fn get_intended_use(&self) -> &Option<AutocompleteIntendedUse>
pub fn get_intended_use(&self) -> &Option<AutocompleteIntendedUse>
Indicates if the results will be stored. Defaults to SingleUse
, if left empty.
Sourcepub fn key(self, input: impl Into<String>) -> Self
pub fn key(self, input: impl Into<String>) -> Self
Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Trait Implementations§
Source§impl Clone for AutocompleteFluentBuilder
impl Clone for AutocompleteFluentBuilder
Source§fn clone(&self) -> AutocompleteFluentBuilder
fn clone(&self) -> AutocompleteFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for AutocompleteFluentBuilder
impl !RefUnwindSafe for AutocompleteFluentBuilder
impl Send for AutocompleteFluentBuilder
impl Sync for AutocompleteFluentBuilder
impl Unpin for AutocompleteFluentBuilder
impl !UnwindSafe for AutocompleteFluentBuilder
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);