Struct prost_types::Any
[−]
[src]
pub struct Any {
pub type_url: String,
pub value: Vec<u8>,
}Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
Example 2: Pack and unpack a message in Java.
Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); }
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... }
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON
The JSON representation of an Any value uses the regular
representation of the deserialized, embedded message, with an
additional field @type which contains the type URL. Example:
package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value which holds the custom JSON in addition to the @type
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
Fields
type_url: String
A URL/resource name whose content describes the type of the serialized protocol buffer message.
For URLs which use the scheme http, https, or no scheme, the
following restrictions and interpretations apply:
- If no scheme is provided,
httpsis assumed. - 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). - 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.)
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.
Trait Implementations
impl Message for Any[src]
fn encode_raw<B>(&self, buf: &mut B) where
B: BufMut, [src]
B: BufMut,
fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where
B: Buf, [src]
B: Buf,
fn encoded_len(&self) -> usize[src]
Returns the encoded length of the message without a length delimiter.
fn clear(&mut self)[src]
Clears the message, resetting all fields to their default.
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut, [src]
B: BufMut,
Encodes the message to a buffer. Read more
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
B: BufMut, [src]
B: BufMut,
Encodes the message with a length-delimiter to a buffer. Read more
fn decode<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default, [src]
B: IntoBuf,
Self: Default,
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
B: IntoBuf,
Self: Default, [src]
B: IntoBuf,
Self: Default,
Decodes a length-delimited instance of the message from the buffer.
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf, [src]
B: IntoBuf,
Decodes an instance of the message from a buffer, and merges it into self. Read more
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
B: IntoBuf, [src]
B: IntoBuf,
Decodes a length-delimited instance of the message from buffer, and merges it into self. Read more
impl Default for Any[src]
impl Clone for Any[src]
fn clone(&self) -> Any[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
Performs copy-assignment from source. Read more