Enum Format

#[repr(i32)]
pub enum Format {
    Unspecified = 0,
    Uuid4 = 1,
    Ipv4 = 2,
    Ipv6 = 3,
    Ipv4OrIpv6 = 4,
}

The standard format of a field value. The supported formats are all backed by either an RFC defined by the IETF or a Google-defined AIP.

Variants

Unspecified = 0

Default, unspecified value.

Uuid4 = 1

Universally Unique Identifier, version 4, value as defined by https://datatracker.ietf.org/doc/html/rfc4122. The value may be normalized to entirely lowercase letters. For example, the value F47AC10B-58CC-0372-8567-0E02B2C3D479 would be normalized to f47ac10b-58cc-0372-8567-0e02b2c3d479.

Ipv4 = 2

Internet Protocol v4 value as defined by RFC 791. The value may be condensed, with leading zeros in each octet stripped. For example, 001.022.233.040 would be condensed to 1.22.233.40.

Ipv6 = 3

Internet Protocol v6 value as defined by RFC 2460. The value may be normalized to entirely lowercase letters with zeros compressed, following RFC 5952. For example, the value 2001:0DB8:0::0 would be normalized to 2001:db8::.

Ipv4OrIpv6 = 4

An IP address in either v4 or v6 format as described by the individual values defined herein. See the comments on the IPV4 and IPV6 types for allowed normalizations of each.

Implementations

impl Format

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of Format.

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

👎Deprecated: Use the TryFrom<i32> implementation instead

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

impl Format

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<Format>

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

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Format

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

Formats the value using the given formatter.

impl Default for Format

fn default() -> Format

Returns the “default value” for a type.

impl Hash for Format

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

where __H: Hasher,

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 Format

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

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

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

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Format

impl Eq for Format

impl StructuralPartialEq for Format