Struct hash40::label_map::LabelMap

pub struct LabelMap {
    pub map: BiHashMap<Hash40, String>,
    pub strict: bool,
}

Fields

map: BiHashMap<Hash40, String>

A bidirectional map to associate hashes and their labels

strict: bool

Controls whether the default hash40 method is used instead of returning None when you try to find the hash of a label which is not present in the map.

By default, set to false

Implementations

impl LabelMap

pub fn clear(&mut self)

Convenience method to clear the labels within the map

pub fn add_labels<I: IntoIterator<Item = String>>(&mut self, labels: I)

Inserts labels into the map, using the default hash40 method for the hash

pub fn add_custom_labels<I: Iterator<Item = (Hash40, String)>>( &mut self, labels: I )

Inserts labels into the map, providing both the hash and the associated label.

Users can insert a label for a hash, even if the hash of the label inserted doesn’t match the paired hash. This allows custom descriptive labels when the true label is not known for the hash.

pub fn read_labels<P: AsRef<Path>>(path: P) -> Result<Vec<String>, Error>

Opens a file and returns a list of newline-separated labels

pub fn read_custom_labels<P: AsRef<Path>>( path: P ) -> Result<Vec<(Hash40, String)>, CustomLabelError>

Opens a file and returns a list of line-separated pairs of hashes and labels. Each hash-label pair is separated by a comma, and the hash must be formatted in hexadecimal, beginning with “0x”

pub fn add_labels_from_path<P: AsRef<Path>>( &mut self, path: P ) -> Result<(), Error>

A combination of the two functions Self::add_labels and Self::read_labels

pub fn add_custom_labels_from_path<P: AsRef<Path>>( &mut self, path: P ) -> Result<(), CustomLabelError>

A combination of the two functions Self::add_custom_labels and Self::read_custom_labels

pub fn label_of(&self, hash: Hash40) -> Option<String>

pub fn hash_of(&self, label: &str) -> Option<Hash40>

Trait Implementations

impl Clone for LabelMap

fn clone(&self) -> LabelMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LabelMap

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

Formats the value using the given formatter.

impl Default for LabelMap

fn default() -> LabelMap

Returns the “default value” for a type.