Struct DistanceLimit

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>,
}

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

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 max_meters(&self) -> i64

Returns the value of max_meters, or the default value if max_meters is unset.

pub fn soft_max_meters(&self) -> i64

Returns the value of soft_max_meters, or the default value if soft_max_meters is unset.

pub fn cost_per_kilometer_above_soft_max(&self) -> f64

Returns the value of cost_per_kilometer_above_soft_max, or the default value if cost_per_kilometer_above_soft_max is unset.

pub fn cost_per_kilometer_below_soft_max(&self) -> f64

Returns the value of cost_per_kilometer_below_soft_max, or the default value if cost_per_kilometer_below_soft_max is unset.

Trait Implementations

impl Clone for DistanceLimit

fn clone(&self) -> DistanceLimit

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for DistanceLimit

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DistanceLimit

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for DistanceLimit

impl StructuralPartialEq for DistanceLimit