Struct LoadLimit

#[non_exhaustive]
pub struct LoadLimit {
    pub max_load: Option<i64>,
    pub soft_max_load: i64,
    pub cost_per_unit_above_soft_max: f64,
    pub start_load_interval: Option<Interval>,
    pub end_load_interval: Option<Interval>,
    /* private fields */
}

Defines a load limit applying to a vehicle, e.g. “this truck may only carry up to 3500 kg”. See load_limits.

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_load: Option<i64>

The maximum acceptable amount of load.

soft_max_load: i64

A soft limit of the load. See cost_per_unit_above_soft_max.

cost_per_unit_above_soft_max: f64

If the load ever exceeds soft_max_load along this vehicle’s route, the following cost penalty applies (only once per vehicle): (load - soft_max_load)

• cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost.

start_load_interval: Option<Interval>

The acceptable load interval of the vehicle at the start of the route.

end_load_interval: Option<Interval>

The acceptable load interval of the vehicle at the end of the route.

Implementations

impl LoadLimit

pub fn new() -> Self

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

where T: Into<i64>,

Sets the value of max_load.

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

where T: Into<i64>,

Sets or clears the value of max_load.

pub fn set_soft_max_load<T: Into<i64>>(self, v: T) -> Self

Sets the value of soft_max_load.

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

Sets the value of cost_per_unit_above_soft_max.

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

where T: Into<Interval>,

Sets the value of start_load_interval.

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

where T: Into<Interval>,

Sets or clears the value of start_load_interval.

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

where T: Into<Interval>,

Sets the value of end_load_interval.

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

where T: Into<Interval>,

Sets or clears the value of end_load_interval.

Trait Implementations

impl Clone for LoadLimit

fn clone(&self) -> LoadLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoadLimit

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

Formats the value using the given formatter.

impl Default for LoadLimit

fn default() -> LoadLimit

Returns the “default value” for a type.

impl Message for LoadLimit

fn typename() -> &'static str

The typename of this message.

impl PartialEq for LoadLimit

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