Struct ToolOutputPath

pub struct ToolOutputPath {
    pub kind: ToolOutputPathKind,
    pub tool: ValgrindTool,
    pub baseline_kind: BaselineKind,
    pub dir: PathBuf,
    pub name: String,
    pub modifiers: Vec<String>,
}

Available on crate feature runner only.

Fields

kind: ToolOutputPathKind

tool: ValgrindTool

baseline_kind: BaselineKind

dir: PathBuf

The final directory of all the output files

name: String

modifiers: Vec<String>

Implementations

impl ToolOutputPath

pub fn new( kind: ToolOutputPathKind, tool: ValgrindTool, baseline_kind: &BaselineKind, base_dir: &Path, module: &ModulePath, name: &str, ) -> Self

Create a new ToolOutputPath.

The base_dir is supposed to be the same as crate::runner::meta::Metadata::target_dir.

pub fn with_init( kind: ToolOutputPathKind, tool: ValgrindTool, baseline_kind: &BaselineKind, base_dir: &Path, module: &str, name: &str, ) -> Result<Self>

Initialize and create the output directory and organize files

This method moves the old output to $TOOL_ID.*.out.old

pub fn init(&self) -> Result<()>

pub fn clear(&self) -> Result<()>

pub fn shift(&self) -> Result<()>

pub fn exists(&self) -> bool

pub fn is_multiple(&self) -> bool

pub fn to_base_path(&self) -> Self

pub fn to_tool_output(&self, tool: ValgrindTool) -> Self

pub fn to_log_output(&self) -> Self

pub fn dump_log(&self, log_level: Level, writer: &mut impl Write) -> Result<()>

pub fn extension(&self) -> String

This method can only be used to create the path passed to the tools

The modifiers are extrapolated by the tools and won’t match any real path name.

pub fn with_modifiers<I, T>(&self, modifiers: T) -> Self

where I: Into<String>, T: IntoIterator<Item = I>,

pub fn to_path(&self) -> PathBuf

pub fn walk_dir(&self) -> Result<impl Iterator<Item = DirEntry>>

Walk the benchmark directory (non-recursive)

pub fn strip_prefix<'a>(&self, file_name: &'a str) -> Option<&'a str>

Strip the <tool>.<name> prefix from a file_name

pub fn prefix(&self) -> String

Return the file name prefix as in <tool>.<name>

pub fn real_paths(&self) -> Result<Vec<PathBuf>>

Return the real paths of a tool’s output files

A tool can have many output files so Self::to_path is not enough

pub fn real_paths_with_modifier(&self) -> Result<Vec<(PathBuf, Option<String>)>>

pub fn sanitize_callgrind(&self) -> Result<()>

Sanitize callgrind output file names

This method will remove empty files which are occasionally produced by callgrind and only cause problems in the parser. The files are renamed from the callgrind file naming scheme to ours which is easier to handle.

The information about pids, parts and threads is obtained by parsing the header from the callgrind output files instead of relying on the sometimes flaky file names produced by callgrind. The header is around 10-20 lines, so this method should be still sufficiently fast. Additionally, callgrind might change the naming scheme of its files, so using the headers makes us more independent of a specific valgrind/callgrind version.

pub fn sanitize_bbv(&self) -> Result<()>

pub fn sanitize_generic(&self) -> Result<()>

Sanitize file names of all tools if not sanitized by a more specific method

The pids are removed from the file name if there was only a single process (pid). Additionally, we check for empty files and remove them.

pub fn sanitize(&self) -> Result<()>

Sanitize file names for a specific tool

Empty files are cleaned up. For more details on a specific tool see the respective sanitize_ method.

Trait Implementations

impl Clone for ToolOutputPath

fn clone(&self) -> ToolOutputPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutputPath

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

Formats the value using the given formatter.

impl Display for ToolOutputPath

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

Formats the value using the given formatter.

impl PartialEq for ToolOutputPath

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

impl StructuralPartialEq for ToolOutputPath