Struct protobuf::well_known_types::any::Any

pub struct Any {
    pub type_url: String,
    pub value: Vec<u8>,
    pub special_fields: SpecialFields,
}

Fields

type_url: String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one “/” character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading “.” is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value: Vec<u8>

Must be a valid serialized protocol buffer of the above specified type.

special_fields: SpecialFields

Implementations

impl Any

pub fn new() -> Any

impl Any

pub fn pack<M: MessageFull>(message: &M) -> Result<Any>

Pack any message into well_known_types::Any value.

Examples

use protobuf::well_known_types::any::Any;

let message: &MyMessage = message;
let any = Any::pack(message)?;
assert!(any.is::<MyMessage>());

pub fn pack_dyn(message: &dyn MessageDyn) -> Result<Any>

Pack any message into well_known_types::Any value.

Examples

use protobuf::{MessageFull, MessageDyn};
use protobuf::well_known_types::any::Any;

let message: &dyn MessageDyn = message;
let any = Any::pack_dyn(message)?;
assert!(any.is_dyn(&message.descriptor_dyn()));

pub fn is<M: MessageFull>(&self) -> bool

Check if Any contains a message of given type.

pub fn is_dyn(&self, descriptor: &MessageDescriptor) -> bool

Check if Any contains a message of given type.

pub fn unpack<M: MessageFull>(&self) -> Result<Option<M>>

Extract a message from this Any.

Returns

• Ok(None) when message type mismatch
• Err when parse failed

pub fn unpack_dyn(
    &self,
    descriptor: &MessageDescriptor
) -> Result<Option<Box<dyn MessageDyn>>>

Extract a message from this Any.

Returns

• Ok(None) when message type mismatch
• Err when parse failed

Trait Implementations

impl Clone for Any

fn clone(&self) -> Any

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Any

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

Formats the value using the given formatter.

impl<'a> Default for &'a Any

fn default() -> &'a Any

Returns the “default value” for a type.

impl Default for Any

fn default() -> Any

Returns the “default value” for a type.

impl Display for Any

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

Formats the value using the given formatter.

impl Message for Any

const NAME: &'static str = "Any"

Message name as specified in .proto file.

fn is_initialized(&self) -> bool

True iff all required fields are initialized. Always returns true for protobuf 3.

fn merge_from(&mut self, is: &mut CodedInputStream<'_>) -> Result<()>

Update this message object with fields read from given stream.

fn compute_size(&self) -> u64

Compute and cache size of this message and all nested messages.

fn write_to_with_cached_sizes(
    &self,
    os: &mut CodedOutputStream<'_>
) -> Result<()>

Write message to the stream.

fn special_fields(&self) -> &SpecialFields

Special fields (unknown fields and cached size).

fn mut_special_fields(&mut self) -> &mut SpecialFields

Special fields (unknown fields and cached size).

fn new() -> Any

Create an empty message object.

fn clear(&mut self)

Reset all fields.

fn default_instance() -> &'static Any

Return a pointer to default immutable message with static lifetime.

fn parse_from(is: &mut CodedInputStream<'_>) -> Result<Self>

Parse message from stream.

fn cached_size(&self) -> u32

Get size previously computed by compute_size.

fn write_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>

Write the message to the stream.

fn write_length_delimited_to(&self, os: &mut CodedOutputStream<'_>) -> Result<()>

Write the message to the stream prepending the message with message length encoded as varint.

fn write_length_delimited_to_vec(&self, vec: &mut Vec<u8>) -> Result<()>

Write the message to the vec, prepend the message with message length encoded as varint.

fn merge_from_bytes(&mut self, bytes: &[u8]) -> Result<()>

Update this message object with fields read from given stream.

fn parse_from_reader(reader: &mut dyn Read) -> Result<Self>

Parse message from reader. Parse stops on EOF or when error encountered.

fn parse_from_bytes(bytes: &[u8]) -> Result<Self>

Parse message from byte array.

fn parse_from_tokio_bytes(bytes: &Bytes) -> Result<Self>

Parse message from Bytes object. Resulting message may share references to the passed bytes object.

fn check_initialized(&self) -> Result<()>

Check if all required fields of this object are initialized.

fn write_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer.

fn write_to_vec(&self, v: &mut Vec<u8>) -> Result<()>

Write the message to bytes vec.

fn write_to_bytes(&self) -> Result<Vec<u8>>

Write the message to bytes vec.

fn write_length_delimited_to_writer(&self, w: &mut dyn Write) -> Result<()>

Write the message to the writer, prepend the message with message length encoded as varint.

fn write_length_delimited_to_bytes(&self) -> Result<Vec<u8>>

Write the message to the bytes vec, prepend the message with message length encoded as varint.

fn unknown_fields(&self) -> &UnknownFields

Get a reference to unknown fields.

fn mut_unknown_fields(&mut self) -> &mut UnknownFields

Get a mutable reference to unknown fields.

impl MessageFull for Any

fn descriptor() -> MessageDescriptor

Get message descriptor for message type.

fn reflect_eq(&self, other: &Self, mode: &ReflectEqMode) -> bool

Reflective equality.

impl PartialEq<Any> for Any

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ProtobufValue for Any

type RuntimeType = RuntimeTypeMessage<Any>

Actual implementation of type properties.

impl StructuralPartialEq for Any