Struct 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:

assert_eq!(e.diagnostic_annotated(),
indoc! {r#"
200(   / envelope /
    201("Hello.")   / leaf /
)
"#}.trim()
);

Implementations

impl FormatContext

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

pub fn is_flat(&self) -> bool

pub fn set_flat(self, flat: bool) -> Self

pub fn tags(&self) -> &TagsStore

pub fn tags_mut(&mut self) -> &mut TagsStore

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 Default for FormatContext

fn default() -> Self

Returns the “default value” for a type.

impl TagsStoreTrait for FormatContext

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

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

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

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

fn summarizer(&self, tag: TagValue) -> Option<&CBORSummarizer>

fn name_for_value(&self, value: u64) -> String

fn name_for_tag_opt<T>(tag: &Tag, tags: Option<&T>) -> String

where T: TagsStoreTrait, Self: Sized,