Enum Code 

#[non_exhaustive]
pub enum Code {
    Unspecified,
    NoVehicle,
    DemandExceedsVehicleCapacity,
    CannotBePerformedWithinVehicleDistanceLimit,
    CannotBePerformedWithinVehicleDurationLimit,
    CannotBePerformedWithinVehicleTravelDurationLimit,
    CannotBePerformedWithinVehicleTimeWindows,
    VehicleNotAllowed,
    UnknownValue(UnknownValue),
}

Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply.

Working with unknown values

This enum is defined as #[non_exhaustive] because Google Cloud may add additional enum variants at any time. Adding new variants is not considered a breaking change. Applications should write their code in anticipation of:

• New values appearing in future releases of the client library, and
• New values received dynamically, without application changes.

Please consult the Working with enums section in the user guide for some guidelines.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified

This should never be used. If we are unable to understand why a shipment was skipped, we simply return an empty set of reasons.

NoVehicle

There is no vehicle in the model making all shipments infeasible.

DemandExceedsVehicleCapacity

The demand of the shipment exceeds a vehicle’s capacity for some capacity types, one of which is example_exceeded_capacity_type.

CannotBePerformedWithinVehicleDistanceLimit

The minimum distance necessary to perform this shipment, i.e. from the vehicle’s start_location to the shipment’s pickup and/or delivery locations and to the vehicle’s end location exceeds the vehicle’s route_distance_limit.

Note that for this computation we use the geodesic distances.

CannotBePerformedWithinVehicleDurationLimit

The minimum time necessary to perform this shipment, including travel time, wait time and service time exceeds the vehicle’s route_duration_limit.

Note: travel time is computed in the best-case scenario, namely as geodesic distance x 36 m/s (roughly 130 km/hour).

CannotBePerformedWithinVehicleTravelDurationLimit

Same as above but we only compare minimum travel time and the vehicle’s travel_duration_limit.

CannotBePerformedWithinVehicleTimeWindows

The vehicle cannot perform this shipment in the best-case scenario (see CANNOT_BE_PERFORMED_WITHIN_VEHICLE_DURATION_LIMIT for time computation) if it starts at its earliest start time: the total time would make the vehicle end after its latest end time.

VehicleNotAllowed

The allowed_vehicle_indices field of the shipment is not empty and this vehicle does not belong to it.

UnknownValue(UnknownValue)

If set, the enum was initialized with an unknown value.

Applications can examine the value using Code::value or Code::name.

Implementations

impl Code

pub fn value(&self) -> Option<i32>

Gets the enum value.

Returns None if the enum contains an unknown value deserialized from the string representation of enums.

pub fn name(&self) -> Option<&str>

Gets the enum value as a string.

Returns None if the enum contains an unknown value deserialized from the integer representation of enums.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl Default for Code

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Code

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Code

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

Formats the value using the given formatter.

impl From<&str> for Code

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<i32> for Code

fn from(value: i32) -> Self

Converts to this type from the input type.

impl PartialEq for Code

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

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 Code