Struct DistanceLimit 

#[non_exhaustive]
pub struct DistanceLimit {
    pub max_meters: Option<i64>,
    pub soft_max_meters: Option<i64>,
    pub cost_per_kilometer_below_soft_max: Option<f64>,
    pub cost_per_kilometer_above_soft_max: Option<f64>,
    /* private fields */
}

A limit defining a maximum distance which can be traveled. It can be either hard or soft.

If a soft limit is defined, both soft_max_meters and cost_per_kilometer_above_soft_max must be defined and be nonnegative.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_meters: Option<i64>

A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.

soft_max_meters: Option<i64>

A soft limit not enforcing a maximum distance limit, but when violated results in a cost which adds up to other costs defined in the model, with the same unit.

If defined soft_max_meters must be less than max_meters and must be nonnegative.

cost_per_kilometer_below_soft_max: Option<f64>

Cost per kilometer incurred, increasing up to soft_max_meters, with formula:

  min(distance_meters, soft_max_meters) / 1000.0 *
  cost_per_kilometer_below_soft_max.

This cost is not supported in route_distance_limit.

cost_per_kilometer_above_soft_max: Option<f64>

Cost per kilometer incurred if distance is above soft_max_meters limit. The additional cost is 0 if the distance is under the limit, otherwise the formula used to compute the cost is the following:

  (distance_meters - soft_max_meters) / 1000.0 *
  cost_per_kilometer_above_soft_max.

The cost must be nonnegative.

Implementations

impl DistanceLimit

pub fn new() -> Self

Creates a new default instance.

pub fn set_max_meters<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of max_meters.

Example

let x = DistanceLimit::new().set_max_meters(42);

pub fn set_or_clear_max_meters<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of max_meters.

Example

let x = DistanceLimit::new().set_or_clear_max_meters(Some(42));
let x = DistanceLimit::new().set_or_clear_max_meters(None::<i32>);

pub fn set_soft_max_meters<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of soft_max_meters.

Example

let x = DistanceLimit::new().set_soft_max_meters(42);

pub fn set_or_clear_soft_max_meters<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of soft_max_meters.

Example

let x = DistanceLimit::new().set_or_clear_soft_max_meters(Some(42));
let x = DistanceLimit::new().set_or_clear_soft_max_meters(None::<i32>);

pub fn set_cost_per_kilometer_below_soft_max<T>(self, v: T) -> Self

where T: Into<f64>,

Sets the value of cost_per_kilometer_below_soft_max.

Example

let x = DistanceLimit::new().set_cost_per_kilometer_below_soft_max(42.0);

pub fn set_or_clear_cost_per_kilometer_below_soft_max<T>( self, v: Option<T>, ) -> Self

where T: Into<f64>,

Sets or clears the value of cost_per_kilometer_below_soft_max.

Example

let x = DistanceLimit::new().set_or_clear_cost_per_kilometer_below_soft_max(Some(42.0));
let x = DistanceLimit::new().set_or_clear_cost_per_kilometer_below_soft_max(None::<f32>);

pub fn set_cost_per_kilometer_above_soft_max<T>(self, v: T) -> Self

where T: Into<f64>,

Sets the value of cost_per_kilometer_above_soft_max.

Example

let x = DistanceLimit::new().set_cost_per_kilometer_above_soft_max(42.0);

pub fn set_or_clear_cost_per_kilometer_above_soft_max<T>( self, v: Option<T>, ) -> Self

where T: Into<f64>,

Sets or clears the value of cost_per_kilometer_above_soft_max.

Example

let x = DistanceLimit::new().set_or_clear_cost_per_kilometer_above_soft_max(Some(42.0));
let x = DistanceLimit::new().set_or_clear_cost_per_kilometer_above_soft_max(None::<f32>);

Trait Implementations

impl Clone for DistanceLimit

fn clone(&self) -> DistanceLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DistanceLimit

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

Formats the value using the given formatter.

impl Default for DistanceLimit

fn default() -> DistanceLimit

Returns the “default value” for a type.

impl Message for DistanceLimit

fn typename() -> &'static str

The typename of this message.

impl PartialEq for DistanceLimit

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DistanceLimit