Struct DurationLimit

#[non_exhaustive]
pub struct DurationLimit {
    pub max_duration: Option<Duration>,
    pub soft_max_duration: Option<Duration>,
    pub cost_per_hour_after_soft_max: Option<f64>,
    pub quadratic_soft_max_duration: Option<Duration>,
    pub cost_per_square_hour_after_quadratic_soft_max: Option<f64>,
}

A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.

When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.

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_duration: Option<Duration>

A hard limit constraining the duration to be at most max_duration.

soft_max_duration: Option<Duration>

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

cost_per_hour_after_soft_max: Option<f64>

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

  cost_per_hour_after_soft_max * (duration - soft_max_duration)

The cost must be nonnegative.

quadratic_soft_max_duration: Option<Duration>

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

max_duration - quadratic_soft_max_duration <= 86400 seconds

cost_per_square_hour_after_quadratic_soft_max: Option<f64>

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

  cost_per_square_hour_after_quadratic_soft_max *
  (duration - quadratic_soft_max_duration)^2

The cost must be nonnegative.

Implementations

impl DurationLimit

pub fn new() -> Self

pub fn set_max_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of max_duration.

pub fn set_soft_max_duration<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of soft_max_duration.

pub fn set_cost_per_hour_after_soft_max<T: Into<Option<f64>>>( self, v: T, ) -> Self

Sets the value of cost_per_hour_after_soft_max.

pub fn set_quadratic_soft_max_duration<T: Into<Option<Duration>>>( self, v: T, ) -> Self

Sets the value of quadratic_soft_max_duration.

pub fn set_cost_per_square_hour_after_quadratic_soft_max<T: Into<Option<f64>>>( self, v: T, ) -> Self

Sets the value of cost_per_square_hour_after_quadratic_soft_max.

Trait Implementations

impl Clone for DurationLimit

fn clone(&self) -> DurationLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DurationLimit

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

Formats the value using the given formatter.

impl Default for DurationLimit

fn default() -> DurationLimit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DurationLimit

where DurationLimit: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for DurationLimit

fn typename() -> &'static str

The typename of this message.

fn to_map(&self) -> Result<Map<String, Value>, AnyError>

where Self: Sized + Serialize,

Store the value into a JSON object.

fn from_map(map: &Map<String, Value>) -> Result<Self, AnyError>

where Self: DeserializeOwned,

Extract the value from a JSON object.

impl PartialEq for DurationLimit

fn eq(&self, other: &DurationLimit) -> 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 Serialize for DurationLimit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DurationLimit