Enum EnumValue 

pub enum EnumValue<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.

Conversion

Use .into() to populate an open enum field from either a generated enum variant or a raw integer. Known variants become Known; unrecognized integers are preserved as Unknown.

use buffa::EnumValue;
// A variant converts into a known value.
let known: EnumValue<Status> = Status::Active.into();
assert_eq!(known, EnumValue::Known(Status::Active));

// An integer off the wire that no variant matches is preserved as-is.
let unknown: EnumValue<Status> = 99.into();
assert_eq!(unknown, EnumValue::Unknown(99));

Variants

Known(E)

A known enum variant.

Unknown(i32)

An unknown value received on the wire.

Implementations

impl<E: Enumeration> EnumValue<E>

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<'a, E: Enumeration + Arbitrary<'a>> Arbitrary<'a> for EnumValue<E>

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<E: Clone + Enumeration> Clone for EnumValue<E>

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: Copy + Enumeration> Copy for EnumValue<E>

impl<E: Enumeration> Debug for EnumValue<E>

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

Formats the value using the given formatter.

impl<E: Enumeration> Default for EnumValue<E>

fn default() -> Self

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<'de, E: Enumeration> Deserialize<'de> for EnumValue<E>

Available on crate feature json only.

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<E: Enumeration> Display for EnumValue<E>

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

Formats the value using the given formatter.

impl<E: Eq + Enumeration> Eq for EnumValue<E>

impl<E: Enumeration> From<E> for EnumValue<E>

fn from(value: E) -> Self

Converts to this type from the input type.

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

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<E: Hash + Enumeration> Hash for EnumValue<E>

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

fn eq(&self, other: &EnumValue<E>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<E: Enumeration> PartialEq<E> for EnumValue<E>

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

Equality operator ==.

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

Inequality operator !=.

impl<E: Enumeration> ProtoElemJson for EnumValue<E>

where Self: Serialize + DeserializeOwned,

Available on crate feature json only.

fn serialize_proto_json<S: Serializer>( v: &Self, s: S, ) -> Result<S::Ok, S::Error>

Serialize this value with proto3 JSON semantics.

fn deserialize_proto_json<'de, D: Deserializer<'de>>( d: D, ) -> Result<Self, D::Error>

Deserialize a value with proto3 JSON semantics.

impl<E: Enumeration> Serialize for EnumValue<E>

Available on crate feature json only.

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<E: PartialEq + Enumeration> StructuralPartialEq for EnumValue<E>