Struct bc_ur::prelude::CBOR

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

A symbolic representation of CBOR data.

Implementations

impl CBOR

pub fn as_case(&self) -> &CBORCase

pub fn into_case(self) -> CBORCase

impl CBOR

Affordances for decoding CBOR from binary representation.

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

Decodes the given date into CBOR symbolic representation.

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.

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

impl CBOR

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

Create a new CBOR value representing a byte string.

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.

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

Create a new CBOR value representing a tagged value.

impl CBOR

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

Extract the CBOR value as a byte string.

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

pub fn into_byte_string(self) -> Option<Bytes>

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.

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.

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.

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.

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.

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.

impl CBOR

Associated constants for common CBOR simple values.

pub fn false() -> CBOR

The CBOR simple value representing false.

pub fn true() -> CBOR

The CBOR simple value representing true.

pub fn null() -> CBOR

The CBOR simple value representing null (None).

impl CBOR

Affordances for viewing CBOR in diagnostic notation.

pub fn diagnostic_opt( &self, annotate: 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.

pub fn diagnostic(&self) -> String

Returns a representation of this CBOR in diagnostic notation.

impl CBOR

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

pub fn hex(&self) -> String

Returns the encoded hexadecimal representation of this CBOR.

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.

Trait Implementations

impl Clone for CBOR

fn clone(&self) -> CBOR

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CBOR

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

Formats the value using the given formatter.

impl Display for CBOR

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

Formats the value using the given formatter.

impl<T> From<&[T]> for CBOR

where T: Into<CBOR> + Clone,

fn from(array: &[T]) -> CBOR

Converts to this type from the input type.

impl From<&str> for CBOR

fn from(value: &str) -> CBOR

Converts to this type from the input type.

impl<T, const N: usize> From<[T; N]> for CBOR

where T: Into<CBOR>,

fn from(array: [T; N]) -> CBOR

Converts to this type from the input type.

impl<K, V> From<BTreeMap<K, V>> for CBOR

where K: Into<CBOR>, V: Into<CBOR>,

fn from(container: BTreeMap<K, V>) -> CBOR

Converts to this type from the input type.

impl From<Bytes> for CBOR

fn from(value: Bytes) -> CBOR

Converts to this type from the input type.

impl From<CBORCase> for CBOR

fn from(case: CBORCase) -> CBOR

Converts to this type from the input type.

impl From<Date> for CBOR

fn from(value: Date) -> CBOR

Converts to this type from the input type.

impl<K, V> From<HashMap<K, V>> for CBOR

where K: Into<CBOR>, V: Into<CBOR>,

fn from(container: HashMap<K, V>) -> CBOR

Converts to this type from the input type.

impl<T> From<HashSet<T>> for CBOR

where T: Into<CBOR>,

fn from(set: HashSet<T>) -> CBOR

Converts to this type from the input type.

impl From<Map> for CBOR

fn from(value: Map) -> CBOR

Converts to this type from the input type.

impl From<Simple> for CBOR

fn from(value: Simple) -> CBOR

Converts to this type from the input type.

impl From<String> for CBOR

fn from(value: String) -> CBOR

Converts to this type from the input type.

impl From<UR> for CBOR

fn from(ur: UR) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for CBOR

where T: Into<CBOR>,

fn from(vec: Vec<T>) -> CBOR

Converts to this type from the input type.

impl<T> From<VecDeque<T>> for CBOR

where T: Into<CBOR>,

fn from(deque: VecDeque<T>) -> CBOR

Converts to this type from the input type.

impl From<bool> for CBOR

fn from(value: bool) -> CBOR

Converts to this type from the input type.

impl From<f16> for CBOR

fn from(value: f16) -> CBOR

Converts to this type from the input type.

impl From<f32> for CBOR

fn from(value: f32) -> CBOR

Converts to this type from the input type.

impl From<f64> for CBOR

fn from(value: f64) -> CBOR

Converts to this type from the input type.

impl From<i16> for CBOR

fn from(value: i16) -> CBOR

Converts to this type from the input type.

impl From<i32> for CBOR

fn from(value: i32) -> CBOR

Converts to this type from the input type.

impl From<i64> for CBOR

fn from(value: i64) -> CBOR

Converts to this type from the input type.

impl From<i8> for CBOR

fn from(value: i8) -> CBOR

Converts to this type from the input type.

impl From<u16> for CBOR

fn from(value: u16) -> CBOR

Converts to this type from the input type.

impl From<u32> for CBOR

fn from(value: u32) -> CBOR

Converts to this type from the input type.

impl From<u64> for CBOR

fn from(value: u64) -> CBOR

Converts to this type from the input type.

impl From<u8> for CBOR

fn from(value: u8) -> CBOR

Converts to this type from the input type.

impl From<usize> for CBOR

fn from(value: usize) -> CBOR

Converts to this type from the input type.

impl PartialEq for CBOR

fn eq(&self, other: &CBOR) -> 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<T> TryFrom<CBOR> for Vec<T>

where T: TryFrom<CBOR, Error = Error> + Clone,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Vec<T>, Error>

Performs the conversion.