Struct Value 

pub struct Value {
    pub kind: Option<Kind>,
    /* private fields */
}

Fields

kind: Option<Kind>

Implementations

impl Value

pub fn null() -> Self

Construct a Value that represents a protobuf null.

pub fn is_null(&self) -> bool

Returns true if this value is the null variant.

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

Returns the f64 value if this is a number, otherwise None.

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

Returns the string value if this is a string, otherwise None.

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

Returns the bool value if this is a bool, otherwise None.

pub fn as_struct(&self) -> Option<&Struct>

Returns a reference to the Struct if this is a struct value.

pub fn as_list(&self) -> Option<&ListValue>

Returns a reference to the ListValue if this is a list value.

pub fn as_struct_mut(&mut self) -> Option<&mut Struct>

Returns a mutable reference to the Struct if this is a struct value.

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

Returns a mutable reference to the ListValue if this is a list value.

impl Value

pub const TYPE_URL: &'static str = "type.googleapis.com/google.protobuf.Value"

Protobuf type URL for this message, for use with Any::pack and Any::unpack_if.

Format: type.googleapis.com/<fully.qualified.TypeName>

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Value

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

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

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 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 Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl DefaultInstance for Value

fn default_instance() -> &'static Self

Return a reference to the single default instance of this type.

impl<'de> Deserialize<'de> for Value

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 From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<ListValue> for Value

fn from(l: ListValue) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Struct> for Value

fn from(s: Struct) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(n: f32) -> Self

Converts an f32 to a Value via f64 widening.

The conversion is lossless for values representable as both f32 and f64; the extra precision bits are filled with zeros.

impl From<f64> for Value

fn from(n: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(n: i32) -> Self

Converts an i32 to a Value via f64.

All i32 values are representable exactly as f64.

impl From<i64> for Value

fn from(n: i64) -> Self

Converts an i64 to a Value via f64.

Precision

f64 has 53 bits of mantissa. i64 values outside [-2^53, 2^53] will be rounded to the nearest representable f64.

impl From<u32> for Value

fn from(n: u32) -> Self

Converts a u32 to a Value via f64.

All u32 values are representable exactly as f64.

impl From<u64> for Value

fn from(n: u64) -> Self

Converts a u64 to a Value via f64.

Precision

f64 has 53 bits of mantissa. u64 values greater than 2^53 will be rounded to the nearest representable f64.

impl FromIterator<Value> for ListValue

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Collect Value items into a ListValue.

impl Message for Value

fn compute_size(&self) -> u32

Returns the total encoded size in bytes.

The result is a u32; the protobuf specification requires all messages to fit within 2 GiB (2,147,483,647 bytes), so a compliant message will never overflow this type.

fn write_to(&self, buf: &mut impl BufMut)

Write this message’s encoded bytes to a buffer.

fn merge_field( &mut self, tag: Tag, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Processes a single already-decoded tag and its associated field data from buf.

fn cached_size(&self) -> u32

The cached encoded size from the last compute_size() call.

fn clear(&mut self)

Clear all fields to their default values.

fn encode(&self, buf: &mut impl BufMut)

Convenience: compute size, then write. This is the primary encoding API.

fn encode_length_delimited(&self, buf: &mut impl BufMut)

Encode this message as a length-delimited byte sequence.

fn encode_to_vec(&self) -> Vec<u8>

Encode this message to a new Vec<u8>.

fn encode_to_bytes(&self) -> Bytes

Encode this message to a new bytes::Bytes.

fn decode(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a buffer.

fn decode_from_slice(data: &[u8]) -> Result<Self, DecodeError>

where Self: Sized,

Decode a message from a byte slice.

fn decode_length_delimited(buf: &mut impl Buf) -> Result<Self, DecodeError>

where Self: Sized,

Decode a length-delimited message from a buffer.

fn merge_to_limit( &mut self, buf: &mut impl Buf, depth: u32, limit: usize, ) -> Result<(), DecodeError>

Merge fields from a buffer until buf.remaining() reaches limit.

fn merge_group( &mut self, buf: &mut impl Buf, depth: u32, field_number: u32, ) -> Result<(), DecodeError>

Merges a group-encoded message from buf, reading fields until an EndGroup tag with the given field_number is encountered.

fn merge(&mut self, buf: &mut impl Buf, depth: u32) -> Result<(), DecodeError>

Merge fields from a buffer into this message.

fn merge_from_slice(&mut self, data: &[u8]) -> Result<(), DecodeError>

Merge fields from a byte slice into this message.

fn merge_length_delimited( &mut self, buf: &mut impl Buf, depth: u32, ) -> Result<(), DecodeError>

Merge fields from a length-delimited sub-message payload into this message.

impl PartialEq for Value

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

Available on crate feature json only.

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

Serializes as the corresponding JSON value.

The null, bool, string, object, and array variants map directly to their JSON counterparts. The number variant serializes as a JSON number via serialize_f64.

Errors

Serialization fails if the number variant holds a non-finite value (NaN, Infinity, -Infinity), because JSON numbers cannot represent those values. Use DoubleValue if you need to serialize non-finite floating-point values (which uses the proto3 JSON string encoding "NaN" / "Infinity" / "-Infinity").

impl StructuralPartialEq for Value