Struct Tagged 

pub struct Tagged<T> {
    pub tag: Option<u64>,
    pub value: T,
}

A value with an optional CBOR tag.

When serialized the tag is written in front of the value, when deserialized the tag (if there is one) is captured. If the value has multiple tags, the outermost tag is captured and the inner tags are left for the value (so Tagged<Tagged<T>> captures two tags).

use deser_cbor::Tagged;

// 1(1363896240): an epoch based date/time
let bytes = deser_cbor::to_vec(&Tagged::new(1, 1363896240u64)).unwrap();
assert_eq!(bytes, [0xc1, 0x1a, 0x51, 0x4b, 0x67, 0xb0]);

let value: Tagged<u64> = deser_cbor::from_slice(&bytes).unwrap();
assert_eq!(value.tag, Some(1));
assert_eq!(value.value, 1363896240);

Other formats do not support tags. When serializing to such formats the tag is dropped, when deserializing the tag is None.

Fields

tag: Option<u64>

The tag of the value.

value: T

The value.

Implementations

impl<T> Tagged<T>

pub fn new(tag: u64, value: T) -> Tagged<T>

Creates a tagged value.

pub fn untagged(value: T) -> Tagged<T>

Creates a value without a tag.

pub fn into_inner(self) -> T

Returns the inner value.

Trait Implementations

impl<T: Clone> Clone for Tagged<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Tagged<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Tagged<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Tagged<T>

fn deserialize_into<'out>( out: &'out mut Option<Self>, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that deserializes the value into the given slot.

fn expecting() -> Cow<'static, str>

Returns what the value expects, for error messages.

fn describe_type(d: &mut dyn Describe)

Describes the Rust shape of the type.

fn deserialize_atom( slot: &mut Slot<T, Self>, atom: Atom<'_>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom into the slot.

fn deserialize_borrowed_atom( slot: &mut Slot<T, Self>, atom: Atom<'de>, state: &mut State, ) -> Result<(), Error>

Deserializes an atom that borrows from the data being deserialized into the slot.

fn initial_value() -> Option<T>

Provides the value of a missing struct field.

fn deserialize_update<'out>( value: &'out mut T, state: &mut State, ) -> SinkHandle<'out, 'de>

Creates a sink that updates an existing value.

impl<T: Eq> Eq for Tagged<T>

impl<T: Hash> Hash for Tagged<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Tagged<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<T: PartialEq> PartialEq for Tagged<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Tagged<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Serialize> Serialize for Tagged<T>

fn serialize<'a>(this: &'a Self, state: &mut State) -> Result<Emit<'a>, Error>

Serializes the value.

fn finish(this: &Self, state: &mut State) -> Result<(), Error>

Invoked after the serialization finished.

fn is_optional(this: &Self) -> bool

Checks if the value represents an optional value.

fn container_shape(this: &Self) -> ContainerShape

Returns the shape of the value if it’s a map or sequence.

fn describe(this: &Self, d: &mut dyn Describe)

Describes the Rust shape of the value.

impl<T: PartialEq> StructuralPartialEq for Tagged<T>