Struct Any 

pub struct Any<E: EncodingMarker = AnyEncoding> { /* private fields */ }

Represents a serialized value, wrapping the underlying serialization and deserialization details, while ensuring that we pass correctly-serialized message throughout the system.

The default Any spelling is encoding-agnostic. Use Any with an encoding marker, such as Any<encoding::Multipart>, when an API requires a specific encoding.

Implementations

impl Any

pub fn serialize_with_encoding<T: Serialize + Named>( encoding: Encoding, value: &T, ) -> Result<Self>

Serialize the value with the using the provided encoding.

pub fn serialize_with_encoding_as<T: Named, U: Serialize>( encoding: Encoding, value: &U, ) -> Result<Self>

Serialize U-typed value as a T-typed value. This should be used with care (typically only in testing), as the value’s representation may be illegally coerced.

pub fn new_broken() -> Self

Create a new broken Any value. A broken value has unknown type and no valid data. Attempting to deserialize a broken value will fail.

pub fn try_into_static_encoding<E: StaticEncoding>(self) -> Result<Any<E>, Self>

Statically constrain this value to the requested encoding.

pub fn try_into_bincode(self) -> Result<Any<Bincode>, Self>

Statically constrain this value to bincode encoding.

pub fn try_into_json(self) -> Result<Any<Json>, Self>

Statically constrain this value to JSON encoding.

pub fn try_into_multipart(self) -> Result<Any<Multipart>, Self>

Statically constrain this value to multipart encoding.

impl<E: EncodingMarker> Any<E>

pub fn serialize<T: Serialize + Named>(value: &T) -> Result<Self>

Construct a new serialized value.

Encoding-agnostic Any uses config::DEFAULT_ENCODING. Statically constrained values, such as Any<encoding::Multipart>, use their static encoding.

pub fn serialize_as<T: Named, U: Serialize>(value: &U) -> Result<Self>

Serialize U-typed value as a T-typed value.

pub fn erase_encoding(self) -> Any

Erase this value’s static encoding marker.

pub fn is_broken(&self) -> bool

Returns true if this Any is broken (unknown type, no value).

pub fn deserialized<T: DeserializeOwned + Named>(&self) -> Result<T>

Deserialize a value to the provided type T.

pub fn deserialized_unchecked<T: DeserializeOwned>(&self) -> Result<T>

Deserialize a value to the provided type T, without checking for type conformance. This should be used carefully, only when you know that the dynamic type check is not needed.

pub fn transcode_to_json(self) -> Result<Any<Json>, Self>

Transcode the serialized value to JSON. This operation will succeed if the type hash is embedded in the value, and the corresponding type is available in this binary.

pub fn dump(&self) -> Result<Value>

Dump the Any message into a JSON value. This will succeed if: 1) the typehash is embedded in the serialized value; 2) the named type is linked into the binary.

pub fn encoding(&self) -> Encoding

The encoding used by this serialized value.

pub fn typehash(&self) -> u64

The typehash of the serialized value.

pub fn typename(&self) -> Option<&'static str>

The typename of the serialized value, if available.

pub fn prefix<T: DeserializeOwned>(&self) -> Result<T>

Deserialize a prefix of the value. This is currently only supported for bincode-serialized values.

pub fn emplace_prefix<T: Serialize + DeserializeOwned>( &mut self, prefix: T, ) -> Result<()>

Emplace a new prefix to this value. This is currently only supported for bincode-serialized values.

pub fn len(&self) -> usize

The length of the underlying serialized message

pub fn is_empty(&self) -> bool

Is the message empty. This should always return false.

pub fn crc(&self) -> u32

Returns the 32bit crc of the serialized data

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

Returns whether this value contains a serialized M-typed value. Returns None when type information is unavailable.

impl Any<Multipart>

pub fn visit_multipart_parts_mut<T, E>( &mut self, f: impl FnMut(&mut T) -> Result<(), E>, ) -> Result<(), E>

where T: Serialize + DeserializeOwned + Named, E: From<Error>,

Visit typed multipart parts in this value.

Trait Implementations

impl<E: Clone + EncodingMarker> Clone for Any<E>

fn clone(&self) -> Any<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + EncodingMarker> Debug for Any<E>

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

Formats the value using the given formatter.

impl<'de, E: EncodingMarker> Deserialize<'de> for Any<E>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E: EncodingMarker> Display for Any<E>

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

Formats the value using the given formatter.

impl<E: PartialEq + EncodingMarker> PartialEq for Any<E>

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<E: EncodingMarker> StructuralPartialEq for Any<E>