Struct defmt_decoder::Table

pub struct Table { /* fields omitted */ }

This is supported on unstable only.

Internal table that holds log levels and maps format strings to indices

Implementations

impl Table

pub fn new(entries: BTreeMap<usize, TableEntry>) -> Self

NOTE caller must verify that defmt symbols are compatible with this version of the decoder crate using the check_version function

pub fn parse(elf: &[u8]) -> Result<Option<Table>, Error>

Parses an ELF file and returns the decoded defmt table.

This function returns None if the ELF file contains no .defmt section.

pub fn parse_ignore_version(elf: &[u8]) -> Result<Option<Table>, Error>

Like parse, but does not verify that the defmt version in the firmware matches the host.

CAUTION: This is meant for defmt/probe-run development only and can result in reading garbage data.

pub fn set_timestamp_entry(&mut self, timestamp: TableEntry)

pub fn indices(&self) -> impl Iterator<Item = usize> + '_

pub fn is_empty(&self) -> bool

pub fn raw_symbols(&self) -> impl Iterator<Item = &str> + '_

Iterates over the raw symbols of the table entries

pub fn get_locations(
    &self,
    elf: &[u8]
) -> Result<BTreeMap<u64, Location>, Error>

pub fn decode<'t>(
    &'t self,
    bytes: &[u8]
) -> Result<(Frame<'t>, usize), DecodeError>

decode the data sent by the device using the previosuly stored metadata

• bytes: contains the data sent by the device that logs. contains the [log string index, timestamp, optional fmt string args]

Trait Implementations

impl Debug for Table

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

Formats the value using the given formatter.