Struct Tool

pub struct Tool {
    pub enable: Option<bool>,
    pub entry_point: Option<EntryPoint>,
    pub flamegraph_config: Option<ToolFlamegraphConfig>,
    pub frames: Option<Vec<String>>,
    pub kind: ValgrindTool,
    pub output_format: Option<ToolOutputFormat>,
    pub raw_args: RawArgs,
    pub regression_config: Option<ToolRegressionConfig>,
    pub show_log: Option<bool>,
}

Available on crate feature api only.

The tool configuration

Fields

enable: Option<bool>

If true the tool is run. Ignored for the default tool which always runs

entry_point: Option<EntryPoint>

The entry point for the tool

flamegraph_config: Option<ToolFlamegraphConfig>

The configuration for flamegraphs

frames: Option<Vec<String>>

Any frames in the call stack which should be considered in addition to the entry point

kind: ValgrindTool

The valgrind tool this configuration is for

output_format: Option<ToolOutputFormat>

The configuration of the output format

raw_args: RawArgs

The arguments to pass to the tool

regression_config: Option<ToolRegressionConfig>

The configuration for regression checks of tools which perform regression checks

show_log: Option<bool>

If true show the logging output of Valgrind (not Iai-Callgrind)

Implementations

impl Tool

pub fn new(kind: ValgrindTool) -> Self

Create a new Tool configuration

pub fn with_args<I, T>(kind: ValgrindTool, args: T) -> Self

where I: AsRef<str>, T: IntoIterator<Item = I>,

Create a new Tool configuration with the given command-line args

pub fn update(&mut self, other: &Self)

Update this tool configuration with another configuration

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tool

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> 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 Serialize for Tool

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tool