Struct criterion_plot::Figure

pub struct Figure { /* fields omitted */ }

Plot container

Methods

impl Figure

pub fn new() -> Figure

Creates an empty figure

pub fn draw(&mut self) -> Result<Child>

Spawns a drawing child process

NOTE: stderr, stdin, and stdout are piped

pub fn dump<W>(&mut self, sink: &mut W) -> Result<&mut Figure> where
    W: Write, 

Dumps the script required to produce the figure into sink

pub fn save(&self, path: &Path) -> Result<&Figure>

Saves the script required to produce the figure to path

Trait Implementations

impl Clone for Figure

fn clone(&self) -> Figure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configure<Axis> for Figure

type Properties = Properties

The properties of what's being configured

fn configure<F>(&mut self, axis: Axis, configure: F) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Configures an axis

impl Configure<Key> for Figure

type Properties = Properties

The properties of what's being configured

fn configure<F>(&mut self, _: Key, configure: F) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Configures the key (legend)

impl<X, WM, BM, BH, WH> Plot<Candlesticks<X, WM, BM, BH, WH>> for Figure where
    BH: IntoIterator,
    BH::Item: Data,
    BM: IntoIterator,
    BM::Item: Data,
    WH: IntoIterator,
    WH::Item: Data,
    WM: IntoIterator,
    WM::Item: Data,
    X: IntoIterator,
    X::Item: Data, 

type Properties = Properties

The properties associated to the plot

fn plot<F>(
    &mut self,
    candlesticks: Candlesticks<X, WM, BM, BH, WH>,
    configure: F
) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Plots some data with some configuration

impl<X, Y> Plot<Curve<X, Y>> for Figure where
    X: IntoIterator,
    X::Item: Data,
    Y: IntoIterator,
    Y::Item: Data, 

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, curve: Curve<X, Y>, configure: F) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Plots some data with some configuration

impl<X, Y, L, H> Plot<ErrorBar<X, Y, L, H>> for Figure where
    H: IntoIterator,
    H::Item: Data,
    L: IntoIterator,
    L::Item: Data,
    X: IntoIterator,
    X::Item: Data,
    Y: IntoIterator,
    Y::Item: Data, 

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, e: ErrorBar<X, Y, L, H>, configure: F) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Plots some data with some configuration

impl<X, Y1, Y2> Plot<FilledCurve<X, Y1, Y2>> for Figure where
    X: IntoIterator,
    X::Item: Data,
    Y1: IntoIterator,
    Y1::Item: Data,
    Y2: IntoIterator,
    Y2::Item: Data, 

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, fc: FilledCurve<X, Y1, Y2>, configure: F) -> &mut Figure where
    F: FnOnce(&mut Properties) -> &mut Properties, 

Plots some data with some configuration

impl Set<BoxWidth> for Figure

fn set(&mut self, width: BoxWidth) -> &mut Figure

Changes the box width of all the box related plots (bars, candlesticks, etc)

Note The default value is 0

Panics

Panics if width is a negative value

impl Set<Font> for Figure

fn set(&mut self, font: Font) -> &mut Figure

Changes the font

impl Set<FontSize> for Figure

fn set(&mut self, size: FontSize) -> &mut Figure

Changes the size of the font

Panics

Panics if size is a non-positive value

impl Set<Output> for Figure

fn set(&mut self, output: Output) -> &mut Figure

Changes the output file

Note The default output file is output.plot

impl Set<Size> for Figure

fn set(&mut self, size: Size) -> &mut Figure

Changes the figure size

impl Set<Terminal> for Figure

fn set(&mut self, terminal: Terminal) -> &mut Figure

Changes the output terminal

Note By default, the terminal is set to Svg

impl Set<Title> for Figure

fn set(&mut self, title: Title) -> &mut Figure

Sets the title