Struct bc_envelope::base::format_context::FormatContext

pub struct FormatContext { /* private fields */ }

The envelope formatting functions take a FormatContext as an argument. This type defines information about CBOR tags, known values, functions and parameters that are used to annotate the output of the formatting functions.

The with_format_context! macro can be used to access the global format context:

with_format_context!(|context| {
    assert_eq!(e.diagnostic_opt(true, Some(context)),
    indoc! {r#"
    200(   / envelope /
       24("Hello.")   / leaf /
    )
    "#}.trim()
    );
});

Implementations

impl FormatContext

pub fn new( tags: Option<&TagsStore>, known_values: Option<&KnownValuesStore>, functions: Option<&FunctionsStore>, parameters: Option<&ParametersStore> ) -> Self

pub fn tags(&self) -> &TagsStore

pub fn assigned_name_for_tag(&self, tag: &Tag) -> Option<String>

pub fn name_for_tag(&self, tag: &Tag) -> String

pub fn tag_for_value(&self, value: u64) -> Option<Tag>

pub fn tag_for_name(&self, name: &str) -> Option<Tag>

pub fn known_values(&self) -> &KnownValuesStore

pub fn functions(&self) -> &FunctionsStore

pub fn parameters(&self) -> &ParametersStore

Trait Implementations

impl Clone for FormatContext

fn clone(&self) -> FormatContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FormatContext

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

Formats the value using the given formatter.

impl Default for FormatContext

fn default() -> Self

Returns the “default value” for a type.