CalculateRoutesInputBuilder

aws_sdk_georoutes::operation::calculate_routes::builders

Struct CalculateRoutesInputBuilder 

Source 
#[non_exhaustive]
pub struct CalculateRoutesInputBuilder { /* private fields */ }
Expand description

A builder for CalculateRoutesInput.

Implementations§

Source§

impl CalculateRoutesInputBuilder

Source

pub fn allow(self, input: RouteAllowOptions) -> Self

Features that are allowed while calculating a route.

Source

pub fn set_allow(self, input: Option<RouteAllowOptions>) -> Self

Features that are allowed while calculating a route.

Source

pub fn get_allow(&self) -> &Option<RouteAllowOptions>

Features that are allowed while calculating a route.

Source

pub fn arrival_time(self, input: impl Into<String>) -> Self

Time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn set_arrival_time(self, input: Option<String>) -> Self

Time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn get_arrival_time(&self) -> &Option<String>

Time of arrival at the destination.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn avoid(self, input: RouteAvoidanceOptions) -> Self

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Source

pub fn set_avoid(self, input: Option<RouteAvoidanceOptions>) -> Self

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Source

pub fn get_avoid(&self) -> &Option<RouteAvoidanceOptions>

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Source

pub fn depart_now(self, input: bool) -> Self

Uses the current time as the time of departure.

Source

pub fn set_depart_now(self, input: Option<bool>) -> Self

Uses the current time as the time of departure.

Source

pub fn get_depart_now(&self) -> &Option<bool>

Uses the current time as the time of departure.

Source

pub fn departure_time(self, input: impl Into<String>) -> Self

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn set_departure_time(self, input: Option<String>) -> Self

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn get_departure_time(&self) -> &Option<String>

Time of departure from thr origin.

Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

Examples:

2020-04-22T17:57:24Z

2020-04-22T17:57:24+02:00

Source

pub fn destination(self, input: f64) -> Self

Appends an item to destination.

To override the contents of this collection use set_destination.

The final position for the route. In the World Geodetic System (WGS 84) format: \[longitude, latitude\].

Source

pub fn set_destination(self, input: Option<Vec<f64>>) -> Self

The final position for the route. In the World Geodetic System (WGS 84) format: \[longitude, latitude\].

Source

pub fn get_destination(&self) -> &Option<Vec<f64>>

The final position for the route. In the World Geodetic System (WGS 84) format: \[longitude, latitude\].

Source

pub fn destination_options(self, input: RouteDestinationOptions) -> Self

Destination related options.

Source

pub fn set_destination_options( self, input: Option<RouteDestinationOptions>, ) -> Self

Destination related options.

Source

pub fn get_destination_options(&self) -> &Option<RouteDestinationOptions>

Destination related options.

Source

pub fn driver(self, input: RouteDriverOptions) -> Self

Driver related options.

Source

pub fn set_driver(self, input: Option<RouteDriverOptions>) -> Self

Driver related options.

Source

pub fn get_driver(&self) -> &Option<RouteDriverOptions>

Driver related options.

Source

pub fn exclude(self, input: RouteExclusionOptions) -> Self

Features to be strictly excluded while calculating the route.

Source

pub fn set_exclude(self, input: Option<RouteExclusionOptions>) -> Self

Features to be strictly excluded while calculating the route.

Source

pub fn get_exclude(&self) -> &Option<RouteExclusionOptions>

Features to be strictly excluded while calculating the route.

Source

pub fn instructions_measurement_system(self, input: MeasurementSystem) -> Self

Measurement system to be used for instructions within steps in the response.

Source

pub fn set_instructions_measurement_system( self, input: Option<MeasurementSystem>, ) -> Self

Measurement system to be used for instructions within steps in the response.

Source

pub fn get_instructions_measurement_system(&self) -> &Option<MeasurementSystem>

Measurement system to be used for instructions within steps in the response.

Source

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.

Source

pub fn set_key(self, input: Option<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.

Source

pub fn get_key(&self) -> &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.

Source

pub fn languages(self, input: impl Into<String>) -> Self

Appends an item to languages.

To override the contents of this collection use set_languages.

List of languages for instructions within steps in the response.

Instructions in the requested language are returned only if they are available.

Source

pub fn set_languages(self, input: Option<Vec<String>>) -> Self

List of languages for instructions within steps in the response.

Instructions in the requested language are returned only if they are available.

Source

pub fn get_languages(&self) -> &Option<Vec<String>>

List of languages for instructions within steps in the response.

Instructions in the requested language are returned only if they are available.

Source

pub fn leg_additional_features(self, input: RouteLegAdditionalFeature) -> Self

Appends an item to leg_additional_features.

To override the contents of this collection use set_leg_additional_features.

A list of optional additional parameters such as timezone that can be requested for each result.

  • Elevation: Retrieves the elevation information for each location.

  • Incidents: Provides information on traffic incidents along the route.

  • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

  • Summary: Returns a summary of the route, including distance and duration.

  • Tolls: Supplies toll cost information along the route.

  • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

  • TruckRoadTypes: Returns information about road types suitable for trucks.

  • TypicalDuration: Gives typical travel duration based on historical data.

  • Zones: Specifies the time zone information for each waypoint.

Source

pub fn set_leg_additional_features( self, input: Option<Vec<RouteLegAdditionalFeature>>, ) -> Self

A list of optional additional parameters such as timezone that can be requested for each result.

  • Elevation: Retrieves the elevation information for each location.

  • Incidents: Provides information on traffic incidents along the route.

  • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

  • Summary: Returns a summary of the route, including distance and duration.

  • Tolls: Supplies toll cost information along the route.

  • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

  • TruckRoadTypes: Returns information about road types suitable for trucks.

  • TypicalDuration: Gives typical travel duration based on historical data.

  • Zones: Specifies the time zone information for each waypoint.

Source

pub fn get_leg_additional_features( &self, ) -> &Option<Vec<RouteLegAdditionalFeature>>

A list of optional additional parameters such as timezone that can be requested for each result.

  • Elevation: Retrieves the elevation information for each location.

  • Incidents: Provides information on traffic incidents along the route.

  • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

  • Summary: Returns a summary of the route, including distance and duration.

  • Tolls: Supplies toll cost information along the route.

  • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

  • TruckRoadTypes: Returns information about road types suitable for trucks.

  • TypicalDuration: Gives typical travel duration based on historical data.

  • Zones: Specifies the time zone information for each waypoint.

Source

pub fn leg_geometry_format(self, input: GeometryFormat) -> Self

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

Source

pub fn set_leg_geometry_format(self, input: Option<GeometryFormat>) -> Self

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

Source

pub fn get_leg_geometry_format(&self) -> &Option<GeometryFormat>

Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

Source

pub fn max_alternatives(self, input: i32) -> Self

Maximum number of alternative routes to be provided in the response, if available.

Source

pub fn set_max_alternatives(self, input: Option<i32>) -> Self

Maximum number of alternative routes to be provided in the response, if available.

Source

pub fn get_max_alternatives(&self) -> &Option<i32>

Maximum number of alternative routes to be provided in the response, if available.

Source

pub fn optimize_routing_for(self, input: RoutingObjective) -> Self

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

Source

pub fn set_optimize_routing_for(self, input: Option<RoutingObjective>) -> Self

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

Source

pub fn get_optimize_routing_for(&self) -> &Option<RoutingObjective>

Specifies the optimization criteria for calculating a route.

Default Value: FastestRoute

Source

pub fn origin(self, input: f64) -> Self

Appends an item to origin.

To override the contents of this collection use set_origin.

The start position for the route.

Source

pub fn set_origin(self, input: Option<Vec<f64>>) -> Self

The start position for the route.

Source

pub fn get_origin(&self) -> &Option<Vec<f64>>

The start position for the route.

Source

pub fn origin_options(self, input: RouteOriginOptions) -> Self

Origin related options.

Source

pub fn set_origin_options(self, input: Option<RouteOriginOptions>) -> Self

Origin related options.

Source

pub fn get_origin_options(&self) -> &Option<RouteOriginOptions>

Origin related options.

Source

pub fn span_additional_features(self, input: RouteSpanAdditionalFeature) -> Self

Appends an item to span_additional_features.

To override the contents of this collection use set_span_additional_features.

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

Source

pub fn set_span_additional_features( self, input: Option<Vec<RouteSpanAdditionalFeature>>, ) -> Self

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

Source

pub fn get_span_additional_features( &self, ) -> &Option<Vec<RouteSpanAdditionalFeature>>

A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

Source

pub fn tolls(self, input: RouteTollOptions) -> Self

Toll related options.

Source

pub fn set_tolls(self, input: Option<RouteTollOptions>) -> Self

Toll related options.

Source

pub fn get_tolls(&self) -> &Option<RouteTollOptions>

Toll related options.

Source

pub fn traffic(self, input: RouteTrafficOptions) -> Self

Traffic related options.

Source

pub fn set_traffic(self, input: Option<RouteTrafficOptions>) -> Self

Traffic related options.

Source

pub fn get_traffic(&self) -> &Option<RouteTrafficOptions>

Traffic related options.

Source

pub fn travel_mode(self, input: RouteTravelMode) -> Self

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Source

pub fn set_travel_mode(self, input: Option<RouteTravelMode>) -> Self

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Source

pub fn get_travel_mode(&self) -> &Option<RouteTravelMode>

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

Default Value: Car

Source

pub fn travel_mode_options(self, input: RouteTravelModeOptions) -> Self

Travel mode related options for the provided travel mode.

Source

pub fn set_travel_mode_options( self, input: Option<RouteTravelModeOptions>, ) -> Self

Travel mode related options for the provided travel mode.

Source

pub fn get_travel_mode_options(&self) -> &Option<RouteTravelModeOptions>

Travel mode related options for the provided travel mode.

Source

pub fn travel_step_type(self, input: RouteTravelStepType) -> Self

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

Source

pub fn set_travel_step_type(self, input: Option<RouteTravelStepType>) -> Self

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

Source

pub fn get_travel_step_type(&self) -> &Option<RouteTravelStepType>

Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

Source

pub fn waypoints(self, input: RouteWaypoint) -> Self

Appends an item to waypoints.

To override the contents of this collection use set_waypoints.

List of waypoints between the Origin and Destination.

Source

pub fn set_waypoints(self, input: Option<Vec<RouteWaypoint>>) -> Self

List of waypoints between the Origin and Destination.

Source

pub fn get_waypoints(&self) -> &Option<Vec<RouteWaypoint>>

List of waypoints between the Origin and Destination.

Source

pub fn build(self) -> Result<CalculateRoutesInput, BuildError>

Consumes the builder and constructs a CalculateRoutesInput.

Source§

impl CalculateRoutesInputBuilder

Source

pub async fn send_with( self, client: &Client, ) -> Result<CalculateRoutesOutput, SdkError<CalculateRoutesError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations§

Source§

impl Clone for CalculateRoutesInputBuilder

Source§

fn clone(&self) -> CalculateRoutesInputBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CalculateRoutesInputBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CalculateRoutesInputBuilder

Source§

fn default() -> CalculateRoutesInputBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for CalculateRoutesInputBuilder

Source§

fn eq(&self, other: &CalculateRoutesInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CalculateRoutesInputBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more