Enum Value 

pub enum Value {
    Bool(bool),
    I32(i32),
    I64(i64),
    U32(u32),
    U64(u64),
    F32(f32),
    F64(f64),
    String(String),
    Bytes(Bytes),
    EnumNumber(i32),
    Message(DynamicMessage),
    List(Vec<Value>),
    Map(HashMap<MapKey, Value>),
}

Available on crate feature dynamic only.

A protobuf field value carried by super::DynamicMessage.

One variant per scalar wire type, plus EnumNumber (open-enum semantics — any i32 is acceptable so unknown variants round-trip losslessly), Message, List, and Map. The variant set mirrors prost-reflect’s Value for consumer migration.

Variants

Bool(bool)

bool.

I32(i32)

int32 / sint32 / sfixed32.

I64(i64)

int64 / sint64 / sfixed64.

U32(u32)

uint32 / fixed32.

U64(u64)

uint64 / fixed64.

F32(f32)

float.

F64(f64)

double.

String(String)

string (UTF-8).

Bytes(Bytes)

bytes.

EnumNumber(i32)

Enum variant by number.

i32 rather than a typed variant so forward-compat decoding (an unknown enum number) round-trips byte-identically. Matches proto3’s open-enum semantics.

Message(DynamicMessage)

Sub-message.

List(Vec<Value>)

Repeated value (every element validated against the list’s declared element Kind).

Map(HashMap<MapKey, Value>)

map<K, V> field.

Implementations

impl Value

pub fn default_value(kind: &Kind) -> Self

The proto default for the given Kind (singular form).

For Message returns an empty super::DynamicMessage of the declared sub-message type. For Enum, the zero variant.

pub fn default_value_for_field(field: &FieldDescriptor) -> Self

The proto default for field accounting for cardinality (lists and maps default to the empty collection).

Reads any pre-parsed [default = …] from the descriptor pool. When the descriptor declares no explicit default this returns the zero value for the field’s Kind.

pub fn is_default(&self, kind: &Kind) -> bool

True iff self equals the proto default for kind.

Lists and maps are default iff empty. Message is default iff it is a fresh, populated-fields-empty instance.

pub fn is_valid_for_field(&self, field: &FieldDescriptor) -> bool

Validate that self matches field’s declared shape.

Recursive: list elements validate against the element kind, map keys/values against their declared kinds, and sub-message values must share the field’s expected message descriptor (compared pool-pointer + index).

pub fn as_bool(&self) -> Option<bool>

Returns the bool payload, if any.

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

Returns the i32 payload, if any.

pub fn as_i64(&self) -> Option<i64>

Returns the i64 payload, if any.

pub fn as_u32(&self) -> Option<u32>

Returns the u32 payload, if any.

pub fn as_u64(&self) -> Option<u64>

Returns the u64 payload, if any.

pub fn as_f32(&self) -> Option<f32>

Returns the f32 payload, if any.

pub fn as_f64(&self) -> Option<f64>

Returns the f64 payload, if any.

pub fn as_str(&self) -> Option<&str>

Returns the &str payload, if any.

pub fn as_bytes(&self) -> Option<&Bytes>

Returns the &Bytes payload, if any.

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

Returns the enum-number payload, if any.

pub fn as_message(&self) -> Option<&DynamicMessage>

Returns the super::DynamicMessage payload, if any.

pub fn as_message_mut(&mut self) -> Option<&mut DynamicMessage>

Mutable form of Self::as_message.

pub fn as_list(&self) -> Option<&[Value]>

Returns the list payload, if any.

pub fn as_list_mut(&mut self) -> Option<&mut Vec<Value>>

Mutable form of Self::as_list.

pub fn as_map(&self) -> Option<&HashMap<MapKey, Value>>

Returns the map payload, if any.

pub fn as_map_mut(&mut self) -> Option<&mut HashMap<MapKey, Value>>

Mutable form of Self::as_map.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl From<&str> for Value

fn from(v: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Value

fn from(v: Bytes) -> Self

Converts to this type from the input type.

impl From<DynamicMessage> for Value

fn from(v: DynamicMessage) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(v: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Value

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

Convenience constructors for common literal types.

fn from(v: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(v: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(v: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(v: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(v: i64) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(v: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(v: u64) -> Self

Converts to this type from the input type.

impl PartialEq for Value

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Value