Struct FrequencyConstraint

#[non_exhaustive]
pub struct FrequencyConstraint {
    pub min_break_duration: Option<Duration>,
    pub max_inter_break_duration: Option<Duration>,
}

One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as “There must be a break of at least 1 hour every 12 hours”. Assuming that this can be interpreted as “Within any sliding time window of 12h, there must be at least one break of at least one hour”, that example would translate to the following FrequencyConstraint:

{
   min_break_duration { seconds: 3600 }         # 1 hour.
   max_inter_break_duration { seconds: 39600 }  # 11 hours (12 - 1 = 11).
}

The timing and duration of the breaks in the solution will respect all such constraints, in addition to the time windows and minimum durations already specified in the BreakRequest.

A FrequencyConstraint may in practice apply to non-consecutive breaks. For example, the following schedule honors the “1h every 12h” example:

  04:00 vehicle start
   .. performing travel and visits ..
  09:00 1 hour break
  10:00 end of the break
   .. performing travel and visits ..
  12:00 20-min lunch break
  12:20 end of the break
   .. performing travel and visits ..
  21:00 1 hour break
  22:00 end of the break
   .. performing travel and visits ..
  23:59 vehicle end

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.

min_break_duration: Option<Duration>

Required. Minimum break duration for this constraint. Nonnegative. See description of FrequencyConstraint.

max_inter_break_duration: Option<Duration>

Required. Maximum allowed span of any interval of time in the route that does not include at least partially a break of duration >= min_break_duration. Must be positive.

Implementations

impl FrequencyConstraint

pub fn new() -> Self

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

Sets the value of min_break_duration.

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

Sets the value of max_inter_break_duration.

Trait Implementations

impl Clone for FrequencyConstraint

fn clone(&self) -> FrequencyConstraint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyConstraint

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

Formats the value using the given formatter.

impl Default for FrequencyConstraint

fn default() -> FrequencyConstraint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FrequencyConstraint

where FrequencyConstraint: 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 FrequencyConstraint

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 FrequencyConstraint

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

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 FrequencyConstraint