Enum FieldBehavior

#[repr(i32)]
pub enum FieldBehavior {
    Unspecified = 0,
    Optional = 1,
    Required = 2,
    OutputOnly = 3,
    InputOnly = 4,
    Immutable = 5,
    UnorderedList = 6,
    NonEmptyDefault = 7,
    Identifier = 8,
}

An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This does not change the behavior in protocol buffers itself; it only denotes the behavior and may affect how API tooling handles the field.

Note: This enum may receive new values in the future.

Variants

Unspecified = 0

Conventional default for enums. Do not use this.

Optional = 1

Specifically denotes a field as optional. While all fields in protocol buffers are optional, this may be specified for emphasis if appropriate.

Required = 2

Denotes a field as required. This indicates that the field must be provided as part of the request, and failure to do so will cause an error (usually INVALID_ARGUMENT).

OutputOnly = 3

Denotes a field as output only. This indicates that the field is provided in responses, but including the field in a request does nothing (the server must ignore it and must not throw an error as a result of the field’s presence).

InputOnly = 4

Denotes a field as input only. This indicates that the field is provided in requests, and the corresponding field is not included in output.

Immutable = 5

Denotes a field as immutable. This indicates that the field may be set once in a request to create a resource, but may not be changed thereafter.

UnorderedList = 6

Denotes that a (repeated) field is an unordered list. This indicates that the service may provide the elements of the list in any arbitrary order, rather than the order the user originally provided. Additionally, the list’s order may or may not be stable.

NonEmptyDefault = 7

Denotes that this field returns a non-empty default value if not set. This indicates that if the user provides the empty value in a request, a non-empty value will be returned. The user will not be aware of what non-empty value to expect.

Identifier = 8

Denotes that the field in a resource (a message annotated with google.api.resource) is used in the resource name to uniquely identify the resource. For AIP-compliant APIs, this should only be applied to the name field on the resource.

This behavior should not be applied to references to other resources within the message.

The identifier field of resources often have different field behavior depending on the request it is embedded in (e.g. for Create methods name is optional and unused, while for Update methods it is required). Instead of method-specific annotations, only IDENTIFIER is required.

Implementations

impl FieldBehavior

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of FieldBehavior.

pub fn from_i32(value: i32) -> Option<FieldBehavior>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a FieldBehavior, or None if value is not a valid variant.

impl FieldBehavior

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for FieldBehavior

fn clone(&self) -> FieldBehavior

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldBehavior

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

Formats the value using the given formatter.

impl Default for FieldBehavior

fn default() -> FieldBehavior

Returns the “default value” for a type.

impl From<FieldBehavior> for i32

fn from(value: FieldBehavior) -> i32

Converts to this type from the input type.

impl Hash for FieldBehavior

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FieldBehavior

fn cmp(&self, other: &FieldBehavior) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FieldBehavior

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

fn partial_cmp(&self, other: &FieldBehavior) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for FieldBehavior

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<FieldBehavior, UnknownEnumValue>

Performs the conversion.

impl Copy for FieldBehavior

impl Eq for FieldBehavior

impl StructuralPartialEq for FieldBehavior