Struct FieldReference 

#[non_exhaustive]
pub struct FieldReference {
    pub name: String,
    pub sub_field: Option<Box<FieldReference>>,
    pub index_or_key: Option<IndexOrKey>,
    /* private fields */
}

Specifies a context for the validation error. A FieldReference always refers to a given field in this file and follows the same hierarchical structure. For example, we may specify element #2 of start_time_windows of vehicle #5 using:

name: "vehicles" index: 5 sub_field { name: "end_time_windows" index: 2 }

We however omit top-level entities such as OptimizeToursRequest or ShipmentModel to avoid crowding the message.

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.

name: String

Name of the field, e.g., “vehicles”.

sub_field: Option<Box<FieldReference>>

Recursively nested sub-field, if needed.

index_or_key: Option<IndexOrKey>

Implementations

impl FieldReference

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = FieldReference::new().set_name("example");

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

where T: Into<FieldReference>,

Sets the value of sub_field.

Example

let x = FieldReference::new().set_sub_field(FieldReference::default()/* use setters */);

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

where T: Into<FieldReference>,

Sets or clears the value of sub_field.

Example

let x = FieldReference::new().set_or_clear_sub_field(Some(FieldReference::default()/* use setters */));
let x = FieldReference::new().set_or_clear_sub_field(None::<FieldReference>);

pub fn set_index_or_key<T: Into<Option<IndexOrKey>>>(self, v: T) -> Self

Sets the value of index_or_key.

Note that all the setters affecting index_or_key are mutually exclusive.

Example

use google_cloud_optimization_v1::model::optimize_tours_validation_error::field_reference::IndexOrKey;
let x = FieldReference::new().set_index_or_key(Some(IndexOrKey::Index(42)));

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

The value of index_or_key if it holds a Index, None if the field is not set or holds a different branch.

pub fn set_index<T: Into<i32>>(self, v: T) -> Self

Sets the value of index_or_key to hold a Index.

Note that all the setters affecting index_or_key are mutually exclusive.

Example

let x = FieldReference::new().set_index(42);
assert!(x.index().is_some());
assert!(x.key().is_none());

pub fn key(&self) -> Option<&String>

The value of index_or_key if it holds a Key, None if the field is not set or holds a different branch.

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

Sets the value of index_or_key to hold a Key.

Note that all the setters affecting index_or_key are mutually exclusive.

Example

let x = FieldReference::new().set_key("example");
assert!(x.key().is_some());
assert!(x.index().is_none());

Trait Implementations

impl Clone for FieldReference

fn clone(&self) -> FieldReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldReference

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

Formats the value using the given formatter.

impl Default for FieldReference

fn default() -> FieldReference

Returns the “default value” for a type.

impl Message for FieldReference

fn typename() -> &'static str

The typename of this message.

impl PartialEq for FieldReference

fn eq(&self, other: &FieldReference) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FieldReference