Struct inferno::flamegraph::color::PaletteMap

pub struct PaletteMap(_);

Mapping of the association between a function name and the color used when drawing information from this function.

Methods

impl PaletteMap

pub fn get(&self, func: &str) -> Option<Color>

Returns the color value corresponding to the given function name.

pub fn insert<S: ToString>(&mut self, func: S, color: Color) -> Option<Color>

Inserts a function name/color pair in the map.

pub fn iter(&self) -> impl Iterator<Item = (&str, Color)>

Provides an iterator over the elements of the map.

pub fn from_reader(reader: &mut dyn BufRead) -> Result<Self>

Builds a mapping based on the inputs given by the reader.

The reader should provide name/color pairs as text input, each pair separated by a line separator.

Each line should follow the format: NAME->rgb(RED, GREEN, BLUE) where NAME is the function name, and RED, GREEN, BLUE integer values between 0 and 255 included. Any line which does not follow the previous format will be ignored.

This function will propagate any std::io::Error returned by the given reader.

pub fn to_writer(&self, writer: &mut dyn Write) -> Result<()>

Writes the palette map using the given writer. The output content will follow the same format described in [from_stream()] The name/color pairs will be sorted by name in lexicographic order.

pub fn load_from_file_or_empty(path: &dyn AsRef<Path>) -> Result<Self>

Utility function to load a palette map from a file.

The file content should follow the format described in [from_stream()].

If the file does not exist, an empty palette map is returned.

pub fn save_to_file(&self, path: &dyn AsRef<Path>) -> Result<()>

Utility function to save a palette map to a file.

The file content will follow the format described in [from_stream()].

Trait Implementations

impl Eq for PaletteMap

impl Default for PaletteMap

fn default() -> PaletteMap

Returns the "default value" for a type.

impl Clone for PaletteMap

fn clone(&self) -> PaletteMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<PaletteMap> for PaletteMap

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for PaletteMap

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

Formats the value using the given formatter.