Struct FixedLengthFileMockerBuilder

pub struct FixedLengthFileMockerBuilder { /* private fields */ }

A helper struct for building an instance of a FixedLengthFileMocker struct.

Implementations

impl FixedLengthFileMockerBuilder

pub fn with_schema(self, schema_path: PathBuf) -> Self

Set the relative or absolute path to the json schema file to use.

pub fn with_out_file(self, out_path: PathBuf) -> Self

Set the relative or absolute path to the output file to produce.

pub fn with_num_rows(self, n_rows: usize) -> Self

Set the number of rows to generate.

pub fn with_num_threads(self, n_thread: usize) -> Self

Set the number of threads (logical cores) to use.

pub fn with_write_buffer_size(self, buffer_size: usize) -> Self

Set the buffer size for writing to file (in number of rows).

pub fn with_force_create_new(self, force_create_new: bool) -> Self

Set the writer option to return an error if the file already exists.

pub fn with_truncate_existing(self, truncate_existing: bool) -> Self

Set the writer option to truncate the output file if it already exists.

pub fn with_thread_channel_capacity(self, capacity: Option<usize>) -> Self

pub fn with_default_values(self) -> Self

Set default values for the optional configuration fields.

Note

Default mode is always single-threaded since I/O bottleneck leads to multithreading not being efficient.

pub fn try_build(self) -> Result<FixedLengthFileMocker>

Try creating a new FixedLengthFileMocker from the previously set values.

Errors

If any of the required fields are None, or if the schema deserialization failed.

pub fn build(self) -> FixedLengthFileMocker

Creates a new FixedLengthFileMocker from the previously set values.

Note

This method internally calls the try_build method and simply unwraps the returned Result. If you don’t care about error propagation, use this method over try_build.

Panics

If any of the required fields are None, or if the schema deserialization failed.

Trait Implementations

impl Default for FixedLengthFileMockerBuilder

fn default() -> FixedLengthFileMockerBuilder

Returns the “default value” for a type.