Enum EnumValue 

pub enum EnumValue<E>
where
    E: Enumeration,
{
    Known(E),
    Unknown(i32),
}

A protobuf enum field value that can hold either a known variant or an unknown i32 value.

Used for open enums (the default in editions). Open enums accept any i32 value on the wire, even if it doesn’t correspond to a known variant.

Variants

Known(E)

A known enum variant.

Unknown(i32)

An unknown value received on the wire.

Implementations

impl<E> EnumValue<E>

where E: Enumeration,

pub fn to_i32(&self) -> i32

Get the i32 wire value.

pub fn is_known(&self) -> bool

Returns true if this is a known enum variant.

This is a shorthand for self.as_known().is_some(), mirroring the MessageField::is_set pattern.

pub fn is_unknown(&self) -> bool

Returns true if the wire value was not recognized as a known variant.

pub fn as_known(&self) -> Option<E>

Try to convert to a known enum variant.

Trait Implementations

impl<E> Clone for EnumValue<E>

where E: Clone + Enumeration,

fn clone(&self) -> EnumValue<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> Debug for EnumValue<E>

where E: Enumeration,

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

Formats the value using the given formatter.

impl<E> Default for EnumValue<E>

where E: Enumeration,

fn default() -> EnumValue<E>

Returns the default value for this enum field.

Per the protobuf specification, the default value for an enum field is the variant whose wire value is 0. If 0 is not a defined variant of E, this returns EnumValue::Unknown(0), which is the correct protobuf default but may be surprising — the field’s default is technically an unknown variant.

impl<E> Display for EnumValue<E>

where E: Enumeration,

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

Formats the value using the given formatter.

impl<E> From<E> for EnumValue<E>

where E: Enumeration,

fn from(value: E) -> EnumValue<E>

Converts to this type from the input type.

impl<E> From<i32> for EnumValue<E>

where E: Enumeration,

fn from(value: i32) -> EnumValue<E>

Converts to this type from the input type.

impl<E> Hash for EnumValue<E>

where E: Hash + Enumeration,

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<E> PartialEq<E> for EnumValue<E>

where E: Enumeration,

Compare an EnumValue directly with a known variant: field == MyEnum::Foo.

Returns true only when self is Known(e) and e == *other. An Unknown value is never equal to any known variant.

Asymmetry

Only the EnumValue == E direction is available; the reverse E == EnumValue is not implementable due to the orphan rule. If you need to compare in that order, use field.as_known() == Some(variant) instead.

fn eq(&self, other: &E) -> 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<E> PartialEq for EnumValue<E>

where E: PartialEq + Enumeration,

fn eq(&self, other: &EnumValue<E>) -> 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<E> Copy for EnumValue<E>

where E: Copy + Enumeration,

impl<E> Eq for EnumValue<E>

where E: Eq + Enumeration,

impl<E> StructuralPartialEq for EnumValue<E>

where E: Enumeration,