[go: up one dir, main page]

Trait inferno::collapse::Collapse[−][src]

pub trait Collapse {
    fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()>
    where
        R: BufRead,
        W: Write;

    fn is_applicable(&mut self, input: &str) -> Option<bool>;

    fn collapse_file<P, W>(
        &mut self, 
        infile: Option<P>, 
        writer: W
    ) -> Result<()>
    where
        P: AsRef<Path>,
        W: Write,
    { ... }

    fn collapse_file_to_stdout<P>(&mut self, infile: Option<P>) -> Result<()>
    where
        P: AsRef<Path>,
    { ... }
}
Expand description

The abstract behavior of stack collapsing.

Implementors of this trait are providing a way to take the stack traces produced by a particular profiler’s output (like perf script) and produce lines in the folded stack format expected by [crate::flamegraph::from_sorted_lines].

See also the crate-level documentation for details.

Required methods

fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()> where
    R: BufRead,
    W: Write, [src]

Collapses the contents of the provided reader and writes folded stack lines to the provided writer.

fn is_applicable(&mut self, input: &str) -> Option<bool>[src]

Returns whether this implementation is appropriate for the given input.

  • None means “not sure – need more input”
  • Some(true) means “yes, this implementation should work with this string”
  • Some(false) means “no, this implementation definitely won’t work”

Provided methods

fn collapse_file<P, W>(&mut self, infile: Option<P>, writer: W) -> Result<()> where
    P: AsRef<Path>,
    W: Write, [src]

Collapses the contents of the provided file (or of STDIN if infile is None) and writes folded stack lines to provided writer.

fn collapse_file_to_stdout<P>(&mut self, infile: Option<P>) -> Result<()> where
    P: AsRef<Path>, [src]

Collapses the contents of the provided file (or of STDIN if infile is None) and writes folded stack lines to STDOUT.

Implementors

impl Collapse for inferno::collapse::guess::Folder[src]

fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()> where
    R: BufRead,
    W: Write, [src]

fn is_applicable(&mut self, _line: &str) -> Option<bool>[src]

impl Collapse for inferno::collapse::sample::Folder[src]

fn is_applicable(&mut self, input: &str) -> Option<bool>[src]

Check for start and end lines of a call graph.

fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()> where
    R: BufRead,
    W: Write, [src]

impl Collapse for inferno::collapse::vtune::Folder[src]

fn is_applicable(&mut self, input: &str) -> Option<bool>[src]

Check for header

fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()> where
    R: BufRead,
    W: Write, [src]

impl<T> Collapse for T where
    T: CollapsePrivate, [src]

fn collapse<R, W>(&mut self, reader: R, writer: W) -> Result<()> where
    R: BufRead,
    W: Write, [src]

fn is_applicable(&mut self, input: &str) -> Option<bool>[src]