Struct ElfMetadata

Source
pub struct ElfMetadata { /* private fields */ }
Expand description

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§

Source§

impl ElfMetadata

Source

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.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.