Struct postform_decoder::ElfMetadata

pub struct ElfMetadata { /* private fields */ }

The ElfMetadata struct encapsulates all log metadata contained in the target ELF file. The log metadata contains the target configuration, along with the interned strings and log section markers.

An instance of ElfMetadata is required in order to parse any logs received from the target.

use std::path::Path;
use postform_decoder::{Decoder, ElfMetadata};
fn postform_example(file: &Path) {
    let elf_metadata = ElfMetadata::from_elf_file(file, false).unwrap();

    // Get postform messages from the device
    // This is just an example buffer, assume it comes from the target device
    let message = [0u8; 12];

    // Parse the logs using the elf metadata
    let mut decoder = Decoder::new(&elf_metadata);
    let log = decoder.decode(&message).unwrap();
    println!("{}: {}", log.timestamp, log.message);
}

Implementations

impl ElfMetadata

pub fn from_elf_file(
    elf_path: &Path,
    disable_version_check: bool
) -> Result<Self, Error>

Attempts to instantiate the ElfMetadata struct from the provided ELF file.