Struct criterion_plot::Figure

source ·

pub struct Figure { /* private fields */ }

Expand description

Plot container

Implementations

source

impl Figure

source

pub fn new() -> Figure

Creates an empty figure

source

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

Spawns a drawing child process

NOTE: stderr, stdin, and stdout are piped

source

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

source

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

Saves the script required to produce the figure to path

Trait Implementations

source

impl Clone for Figure

source

fn clone(&self) -> Figure

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Configure<Axis> for Figure

source

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

Configures an axis

type Properties = Properties

The properties of what’s being configured

source

impl Configure<Key> for Figure

source

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

Configures the key (legend)

type Properties = Properties

The properties of what’s being configured

source

impl<X, WM, BM, BH, WH> Plot<Candlesticks<X, WM, BM, BH, WH>> for Figurewhere
 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

source

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

Plots some data with some configuration

source

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

type Properties = Properties

The properties associated to the plot

source

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

Plots some data with some configuration

source

impl<X, Y, L, H> Plot<ErrorBar<X, Y, L, H>> for Figurewhere
 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

source

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

Plots some data with some configuration

source

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

type Properties = Properties

The properties associated to the plot

source

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

Plots some data with some configuration

source

impl Set<BoxWidth> for Figure

source

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

source

impl Set for Figure

source

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

Changes the font

source

impl Set<FontSize> for Figure

source

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

Changes the size of the font

Panics

Panics if size is a non-positive value

source

impl Set<Output> for Figure

source

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

Changes the output file

Note The default output file is output.plot

source

impl Set<Size> for Figure

source

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

Changes the figure size

source

impl Set<Terminal> for Figure

source

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

Changes the output terminal

Note By default, the terminal is set to Svg

source

impl Set<Title> for Figure

source

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

Sets the title

Auto Trait Implementations

impl RefUnwindSafe for Figure

impl Send for Figure

impl Sync for Figure

impl Unpin for Figure

impl UnwindSafe for Figure

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct criterion_plot::Figure

Implementations

impl Figure

pub fn new() -> Figure

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

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

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

Trait Implementations

impl Clone for Figure

fn clone(&self) -> Figure

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

impl Configure<Axis> for Figure

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

type Properties = Properties

impl Configure<Key> for Figure

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

type Properties = Properties

impl<X, WM, BM, BH, WH> Plot<Candlesticks<X, WM, BM, BH, WH>> for Figurewhere 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

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

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

type Properties = Properties

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

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

type Properties = Properties

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

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

type Properties = Properties

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

impl Set<BoxWidth> for Figure

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

impl Set<Font> for Figure

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

impl Set<FontSize> for Figure

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

impl Set<Output> for Figure

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

impl Set<Size> for Figure

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

impl Set<Terminal> for Figure

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

impl Set<Title> for Figure

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

Auto Trait Implementations

impl RefUnwindSafe for Figure

impl Send for Figure

impl Sync for Figure

impl Unpin for Figure

impl UnwindSafe for Figure

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

impl<X, WM, BM, BH, WH> Plot<Candlesticks<X, WM, BM, BH, WH>> for Figurewhere
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,

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

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

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

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

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

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

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,