Struct Reason 

#[non_exhaustive]
pub struct Reason {
    pub code: Code,
    pub example_vehicle_index: Option<i32>,
    pub example_exceeded_capacity_type: String,
    /* private fields */
}

If we can explain why the shipment was skipped, reasons will be listed here. If the reason is not the same for all vehicles, reason will have more than 1 element. A skipped shipment cannot have duplicate reasons, i.e. where all fields are the same except for example_vehicle_index. Example:

reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 1
  example_exceeded_capacity_type: "Apples"
}
reasons {
  code: DEMAND_EXCEEDS_VEHICLE_CAPACITY
  example_vehicle_index: 3
  example_exceeded_capacity_type: "Pears"
}
reasons {
  code: CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DISTANCE_LIMIT
  example_vehicle_index: 1
}

The skipped shipment is incompatible with all vehicles. The reasons may be different for all vehicles but at least one vehicle’s “Apples” capacity would be exceeded (including vehicle 1), at least one vehicle’s “Pears” capacity would be exceeded (including vehicle 3) and at least one vehicle’s distance limit would be exceeded (including vehicle 1).

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.

code: Code

Refer to the comments of Code.

example_vehicle_index: Option<i32>

If the reason is related to a shipment-vehicle incompatibility, this field provides the index of one relevant vehicle.

example_exceeded_capacity_type: String

If the reason code is DEMAND_EXCEEDS_VEHICLE_CAPACITY, documents one capacity type that is exceeded.

Implementations

impl Reason

pub fn new() -> Self

pub fn set_code<T: Into<Code>>(self, v: T) -> Self

Sets the value of code.

Example

use google_cloud_optimization_v1::model::skipped_shipment::reason::Code;
let x0 = Reason::new().set_code(Code::NoVehicle);
let x1 = Reason::new().set_code(Code::DemandExceedsVehicleCapacity);
let x2 = Reason::new().set_code(Code::CannotBePerformedWithinVehicleDistanceLimit);

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

where T: Into<i32>,

Sets the value of example_vehicle_index.

Example

let x = Reason::new().set_example_vehicle_index(42);

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

where T: Into<i32>,

Sets or clears the value of example_vehicle_index.

Example

let x = Reason::new().set_or_clear_example_vehicle_index(Some(42));
let x = Reason::new().set_or_clear_example_vehicle_index(None::<i32>);

pub fn set_example_exceeded_capacity_type<T: Into<String>>(self, v: T) -> Self

Sets the value of example_exceeded_capacity_type.

Example

let x = Reason::new().set_example_exceeded_capacity_type("example");

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reason

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

Formats the value using the given formatter.

impl Default for Reason

fn default() -> Reason

Returns the “default value” for a type.

impl Message for Reason

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Reason

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