Struct CBOR

Source

pub struct CBOR(/* private fields */);

Expand description

A symbolic representation of CBOR data.

Implementations§

Source §

impl CBOR

Affordances for decoding CBOR from binary representation.

Source

pub fn try_from_data(data: impl AsRef<[u8]>) -> Result<CBOR, Error>

Decodes the given date into CBOR symbolic representation.

Source

pub fn try_from_hex(hex: &str) -> Result<CBOR, Error>

Decodes the given data into CBOR symbolic representation given as a hexadecimal string.

Panics if the string is not well-formed hexadecimal with no spaces or other characters.

Source

pub fn to_cbor_data(&self) -> Vec<u8> ⓘ

Source §

impl CBOR

Source

pub fn to_byte_string(data: impl AsRef<[u8]>) -> CBOR

Create a new CBOR value representing a byte string.

Source

pub fn to_byte_string_from_hex(hex: impl AsRef<str>) -> CBOR

Create a new CBOR value representing a byte string given as a hexadecimal string.

Panics if the string is not well-formed hexadecimal.

Source

pub fn to_tagged_value(tag: impl Into<Tag>, item: impl Into<CBOR>) -> CBOR

Create a new CBOR value representing a tagged value.

Source §

impl CBOR

Source

pub fn try_into_byte_string(self) -> Result<Vec<u8>, Error>

Extract the CBOR value as a byte string.

Returns Ok if the value is a byte string, Err otherwise.

Source

pub fn into_byte_string(self) -> Option<Vec<u8>>

Source

pub fn try_into_text(self) -> Result<String, Error>

Extract the CBOR value as a text string.

Returns Ok if the value is a text string, Err otherwise.

Source

pub fn try_into_array(self) -> Result<Vec<CBOR>, Error>

Extract the CBOR value as an array.

Returns Ok if the value is an array, Err otherwise.

Source

pub fn try_into_map(self) -> Result<Map, Error>

Extract the CBOR value as a map.

Returns Ok if the value is a map, Err otherwise.

Source

pub fn try_into_tagged_value(self) -> Result<(Tag, CBOR), Error>

Extract the CBOR value as a tagged value.

Returns Ok if the value is a tagged value, Err otherwise.

Source

pub fn try_into_expected_tagged_value( self, expected_tag: impl Into<Tag>, ) -> Result<CBOR, Error>

Extract the CBOR value as an expected tagged value.

Returns Ok if the value is a tagged value with the expected tag, Err otherwise.

Source

pub fn try_into_simple_value(self) -> Result<Simple, Error>

Extract the CBOR value as a simple value.

Returns Ok if the value is a simple value, Err otherwise.

Source §

impl CBOR

Associated constants for common CBOR simple values.

Source

pub fn false() -> CBOR

The CBOR simple value representing false.

Source

pub fn true() -> CBOR

The CBOR simple value representing true.

Source

pub fn null() -> CBOR

The CBOR simple value representing null (None).

Source §

impl CBOR

Affordances for viewing CBOR in diagnostic notation.

Source

pub fn diagnostic_opt( &self, annotate: bool, summarize: bool, flat: bool, tags: Option<&dyn TagsStoreTrait>, ) -> String

Returns a representation of this CBOR in diagnostic notation.

Optionally annotates the output, e.g. formatting dates and adding names of known tags.

Source

pub fn diagnostic(&self) -> String

Returns a representation of this CBOR in diagnostic notation.

Source

pub fn diagnostic_annotated(&self) -> String

Returns a representation of this CBOR in diagnostic notation, with annotations.

Source

pub fn diagnostic_flat(&self) -> String

Source

pub fn summary(&self) -> String

Source

pub fn summary_opt(&self, tags: &dyn TagsStoreTrait) -> String

Source §

impl CBOR

Affordances for viewing the encoded binary representation of CBOR as hexadecimal.

Source

pub fn hex(&self) -> String

Returns the encoded hexadecimal representation of this CBOR.

Source

pub fn hex_opt( &self, annotate: bool, tags: Option<&dyn TagsStoreTrait>, ) -> String

Returns the encoded hexadecimal representation of this CBOR.

Optionally annotates the output, e.g. breaking the output up into semantically meaningful lines, formatting dates, and adding names of known tags.

Source

pub fn hex_annotated(&self) -> String

Returns the encoded hexadecimal representation of this CBOR, with annotations.

Trait Implementations§

Source §

impl Clone for CBOR

Source §

fn clone(&self) -> CBOR

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for CBOR

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for CBOR

Source §

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

Formats the value using the given formatter. Read more

Source §

impl EnvelopeEncodable for CBOR

Source §

fn into_envelope(self) -> Envelope

Source §

fn to_envelope(&self) -> Envelope
where Self: Clone,

Source §

impl EnvelopeFormat for CBOR

Source §

fn format_item(&self, context: &FormatContext) -> EnvelopeFormatItem

Source §

impl EnvelopeSummary for CBOR

Source §

fn envelope_summary( &self, max_length: usize, context: &FormatContext, ) -> Result<String>

Source §