Struct subplotlib::steplibrary::datadir::Datadir

pub struct Datadir { /* private fields */ }

The Datadir is the context type which provides a directory for each scenario and allows for the creation and testing of files within that directory.

A few steps are provided as part of this step library, though in reality the majority of steps which interact with the data directory are in the files step library, and commands which interact with stuff in here are in the runcmd step library.

Implementations

impl Datadir

pub fn base_path(&self) -> &Path

Retrieve the base data directory path which can be used to store files etc. for this step.

This is used by steps wishing to manipulate the content of the data directory.

pub fn canonicalise_filename<S: AsRef<Path>>( &self, subpath: S ) -> Result<PathBuf, StepError>

Canonicalise a subpath into this dir

This step safely joins the base path to the given subpath. This ensures that, for example, the subpath is relative, does not contain .. elements, etc.

pub fn open_write<S: AsRef<Path>>(&self, subpath: S) -> Result<File, StepError>

Open a file for writing

This is a convenience function to open a file for writing at the given subpath.

pub fn open_read<S: AsRef<Path>>(&self, subpath: S) -> Result<File, StepError>

Open a file for reading

This is a convenience function to open a file for reading from the given subpath

pub fn create_dir_all<S: AsRef<Path>>( &self, subpath: S ) -> Result<(), StepError>

Make a directory tree

Equivalent to mkdir -p this will create the full path to the given subpath allowing subsequent step code to use that directory.

Trait Implementations

impl ContextElement for Datadir

fn created(&mut self, scenario: &Scenario)

A new context element was created.

fn scenario_starts(&mut self) -> StepResult

Scenario starts

fn scenario_stops(&mut self) -> StepResult

Scenario stops

fn step_starts(&mut self, step_title: &str) -> StepResult

Entry to a step function

fn step_stops(&mut self) -> StepResult

Exit from a step function

impl Debug for Datadir

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

Formats the value using the given formatter.

impl Default for Datadir

fn default() -> Datadir

Returns the “default value” for a type.