Struct Vmem

pub struct Vmem { /* private fields */ }

Representation of a VMEM file.

These files consist of sections which are runs of memory starting at some address.

Implementations

impl Vmem

pub fn new(sections: Vec<Section>) -> Self

pub fn from_str(s: &str, addr_stride: Option<usize>) -> Result<Self, ParseError>

Parse a complete VMEM file from the contents of a given string.

impl Vmem

pub fn sections(&self) -> impl Iterator<Item = &Section>

Returns an iterator over sections of the VMEM file.

pub fn dump(&self, bytes_per_word: Option<usize>, addr_per_word: bool) -> String

Serialize the VMEM, dumping it to a string.

The bytes_per_word parameter can be used to control the zero-extension of words.

If addr_per_word is true, then each word will be given its own address on a separate line, with a stride of bytes_per_word between words (default: 1). If it is instead false, an address will only be emitted per each section.

impl Vmem

pub fn data_addrs(&self, stride: usize) -> impl Iterator<Item = Data> + '_

Returns an iterator over all data of the VMEM file.

The stride should either be 1 (one address per word) or the number of bytes in each word.

pub fn merge_sections(&mut self, addr_stride: Option<usize>)

Merge any contiguous sections in the VMEM together.

Trait Implementations

impl Clone for Vmem

fn clone(&self) -> Vmem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vmem

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

Formats the value using the given formatter.

impl Default for Vmem

fn default() -> Vmem

Returns the “default value” for a type.

impl Display for Vmem

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

Formats the value using the given formatter.

impl PartialEq for Vmem

fn eq(&self, other: &Vmem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Vmem

impl StructuralPartialEq for Vmem