pub struct Config<W: WriteColor> { /* private fields */ }
Expand description
Main configuration struct.
This could be set by the user when creating a batch runner, if the default configuration is for some reason not appropriate.
Configuration describes two desitions:
- what to do when there’s no expected output for some entry - this is guided by
Update
enum; - what to do with the runner output - this is configured using
WriterBuilder
struct.
For convinient methods of creating Config
, see Config::from_env
, Config::new
and Config::with_buffer
.
Implementations§
Source§impl Config<StandardStream>
impl Config<StandardStream>
Sourcepub fn from_env() -> BatchResult<Self>
pub fn from_env() -> BatchResult<Self>
Default method of creating config struct.
In this case, the following configuration is assumed:
- update mode is taken from the BATCH_RUN environment variable,
- output is written directly on screen.
Source§impl<W: WriteColor> Config<W>
impl<W: WriteColor> Config<W>
Sourcepub fn new(update_mode: Update, writer: WriterBuilder<W>) -> Self
pub fn new(update_mode: Update, writer: WriterBuilder<W>) -> Self
Explicit constructor for Config
.
pub fn with_buffer(self) -> Config<Buffer>
pub fn with_stderr_no_color(self) -> Config<StandardStream>
pub fn update_mode(&self) -> Update
pub fn writer(&self) -> &WriterBuilder<W>
Auto Trait Implementations§
impl<W> Freeze for Config<W>
impl<W> !RefUnwindSafe for Config<W>
impl<W> !Send for Config<W>
impl<W> !Sync for Config<W>
impl<W> Unpin for Config<W>
impl<W> !UnwindSafe for Config<W>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more