#[non_exhaustive]pub struct GetStyleDescriptorInput {
pub style: Option<MapStyle>,
pub color_scheme: Option<ColorScheme>,
pub political_view: Option<String>,
pub terrain: Option<Terrain>,
pub contour_density: Option<ContourDensity>,
pub traffic: Option<Traffic>,
pub travel_modes: Option<Vec<TravelMode>>,
pub key: Option<String>,
}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.style: Option<MapStyle>Style specifies the desired map style.
color_scheme: Option<ColorScheme>Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
Example: Light
Default value: Light
Valid values for ColorScheme are case sensitive.
political_view: Option<String>Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
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
terrain: Option<Terrain>Adjusts how physical terrain details are rendered on the map.
The following terrain styles are currently supported:
-
Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.
This parameter is valid only for the Standard map style.
contour_density: Option<ContourDensity>Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map.
This parameter is valid only for the Standard map style.
traffic: Option<Traffic>Displays real-time traffic information overlay on map, such as incident events and flow events.
This parameter is valid only for the Standard map style.
travel_modes: Option<Vec<TravelMode>>Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map.
This parameter is valid only for the Standard map style.
key: Option<String>Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.
Implementations§
Source§impl GetStyleDescriptorInput
impl GetStyleDescriptorInput
Sourcepub fn color_scheme(&self) -> Option<&ColorScheme>
pub fn color_scheme(&self) -> Option<&ColorScheme>
Sets color tone for map such as dark and light for specific map styles. It applies to only vector map styles such as Standard and Monochrome.
Example: Light
Default value: Light
Valid values for ColorScheme are case sensitive.
Sourcepub fn political_view(&self) -> Option<&str>
pub fn political_view(&self) -> Option<&str>
Specifies the political view using ISO 3166-2 or ISO 3166-3 country code format.
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 terrain(&self) -> Option<&Terrain>
pub fn terrain(&self) -> Option<&Terrain>
Adjusts how physical terrain details are rendered on the map.
The following terrain styles are currently supported:
-
Hillshade: Displays the physical terrain details through shading and highlighting of elevation change and geographic features.
This parameter is valid only for the Standard map style.
Sourcepub fn contour_density(&self) -> Option<&ContourDensity>
pub fn contour_density(&self) -> Option<&ContourDensity>
Displays the shape and steepness of terrain features using elevation lines. The density value controls how densely the available contour line information is rendered on the map.
This parameter is valid only for the Standard map style.
Sourcepub fn traffic(&self) -> Option<&Traffic>
pub fn traffic(&self) -> Option<&Traffic>
Displays real-time traffic information overlay on map, such as incident events and flow events.
This parameter is valid only for the Standard map style.
Sourcepub fn travel_modes(&self) -> &[TravelMode]
pub fn travel_modes(&self) -> &[TravelMode]
Renders additional map information relevant to selected travel modes. Information for multiple travel modes can be displayed simultaneously, although this increases the overall information density rendered on the map.
This parameter is valid only for the Standard map style.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .travel_modes.is_none().
Source§impl GetStyleDescriptorInput
impl GetStyleDescriptorInput
Sourcepub fn builder() -> GetStyleDescriptorInputBuilder
pub fn builder() -> GetStyleDescriptorInputBuilder
Creates a new builder-style object to manufacture GetStyleDescriptorInput.
Trait Implementations§
Source§impl Clone for GetStyleDescriptorInput
impl Clone for GetStyleDescriptorInput
Source§fn clone(&self) -> GetStyleDescriptorInput
fn clone(&self) -> GetStyleDescriptorInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GetStyleDescriptorInput
impl Debug for GetStyleDescriptorInput
Source§impl PartialEq for GetStyleDescriptorInput
impl PartialEq for GetStyleDescriptorInput
impl StructuralPartialEq for GetStyleDescriptorInput
Auto Trait Implementations§
impl Freeze for GetStyleDescriptorInput
impl RefUnwindSafe for GetStyleDescriptorInput
impl Send for GetStyleDescriptorInput
impl Sync for GetStyleDescriptorInput
impl Unpin for GetStyleDescriptorInput
impl UnwindSafe for GetStyleDescriptorInput
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);