Struct ced::Processor

pub struct Processor { /* private fields */ }

Csv processor

Processor has multiple pages which can be accessed with page_name. Processor has currently selected page which name can be accessed with get_cursor method.

Implementations

impl Processor

Main loop struct for interactive csv editing

pub fn execute_command(&mut self, command: &Command) -> CedResult<()>

Execute given command

pub fn limit_column_from_args(
    &mut self,
    page_name: &str,
    args: &[String]
) -> CedResult<()>

pub fn execute_from_file(&mut self, args: &Vec<String>) -> CedResult<()>

impl Processor

pub fn new() -> Self

Create empty processor

pub fn change_cursor(&mut self, page_name: &str) -> bool

Change current cusor(page)

This doesn’t affect page itself but change cursor.

• This returns boolean value whether change succeeded or not

pub fn get_cursor(&self) -> Option<String>

Get current cursor (page_name)

pub fn add_page(
    &mut self,
    page: &str,
    data: &str,
    has_header: bool,
    line_ending: Option<char>,
    raw_mode: bool
) -> CedResult<()>

Add a new page

Args

• page : Page name to create
• data : Csv data to store inside a page
• has_header : Whether csv data has header or not.
• line_ending : Optional line_ending configuration.
• raw_mode : This decides whether page be data or array

pub fn remove_page(&mut self, page_name: &str)

Remove page with given name

This doesn’t panic and silent do nothing if page name is non-existent

pub fn contains_page(&self, page: &str) -> bool

Check if processor contains a page

pub fn drop_pages(&mut self) -> CedResult<()>

Drop all data from processor

pub fn import_from_file(
    &mut self,
    path: impl AsRef<Path>,
    has_header: bool,
    line_ending: Option<char>,
    raw_mode: bool
) -> CedResult<()>

Import file content as page

This will drop the page if given page name already exists.

Args

• path: File path to import from
• has_header : Whether csv file has header or not
• line_ending : Optional line_ending of csv
• raw_mode : Whether imported as data or array

pub fn write_to_file(&self, page: &str, file: impl AsRef<Path>) -> CedResult<()>

Write all page’s content into a file

pub fn overwrite_to_file(&self, page: &str, cache: bool) -> CedResult<bool>

Overwrite virtual data’s content into a imported file

• cache : whether to backup original file’s content into temp directory

pub fn edit_cell(
    &mut self,
    page: &str,
    x: usize,
    y: usize,
    input: &str
) -> CedResult<()>

Edit a cell by given coordinate

pub fn edit_column(
    &mut self,
    page: &str,
    column: &str,
    input: &str
) -> CedResult<()>

Edit a column by given coordinate

This overwrite all column values with given input

pub fn edit_row(
    &mut self,
    page: &str,
    row_index: usize,
    input: &[Option<Value>]
) -> CedResult<()>

Edit a row with values

This assumes given input accords with order of a target record.

Args

• page : Page name
• row_index : Target row
• input : Inputs are array of options. Some will overwrite and none will not.

pub fn set_row(
    &mut self,
    page: &str,
    row_index: usize,
    input: &[Value]
) -> CedResult<()>

Set a row with given values

This assumes given input accords with order of a target record. This method overwrite an entire row with given values.

pub fn set_row_from_string_array(
    &mut self,
    page: &str,
    row_index: usize,
    input: &[impl AsRef<str>]
) -> CedResult<()>

Set a row with given string array

This assumes given input accords with order of a target record. This method overwrite an entire row with given values.

pub fn add_row(
    &mut self,
    page: &str,
    row_index: usize,
    values: Option<&[Value]>
) -> CedResult<()>

Add a new row

This assumes given input accords with order of a target record.

Args

• page: Target page
• row_index : Target row
• values : Option. “None” will converted as default values.

pub fn add_row_from_string_array(
    &mut self,
    page: &str,
    row_index: usize,
    src: &[impl AsRef<str>]
) -> CedResult<()>

Add a new row but from array of strings

This assumes given input accords with order of a target record.

Args

• page: Target page
• row_index : Target row
• values : Option. “None” will converted as default values.

pub fn add_column(
    &mut self,
    page: &str,
    column_index: usize,
    column_name: &str,
    column_type: ValueType,
    limiter: Option<ValueLimiter>,
    placeholder: Option<Value>
) -> CedResult<()>

Add a new column into a page

pub fn remove_row(&mut self, page: &str, row_index: usize) -> CedResult<bool>

Remove a row from a page

pub fn remove_column(
    &mut self,
    page: &str,
    column_index: usize
) -> CedResult<()>

Remove a column from a page

pub fn add_column_array(
    &mut self,
    page: &str,
    columns: &[impl AsRef<str>]
) -> CedResult<()>

Add columns into a page

This method dosn’t require any column configurators

pub fn move_row(
    &mut self,
    page: &str,
    src: usize,
    target: usize
) -> CedResult<()>

Move a rom from an index to a target index

pub fn move_column(
    &mut self,
    page: &str,
    src: usize,
    target: usize
) -> CedResult<()>

Move a column from an index to a target index

pub fn rename_column(
    &mut self,
    page: &str,
    column: &str,
    new_name: &str
) -> CedResult<()>

Rename a column into a new name

pub fn export_schema(&self, page: &str) -> CedResult<String>

Export page’s schema

pub fn set_schema(
    &mut self,
    page: &str,
    path: impl AsRef<Path>,
    panic: bool
) -> CedResult<()>

Apply schema into a given page

Args

• page : Page name
• path : Schema file path
• panic : Whether to panic if current value fails to qualify schema. If not every unqualified values are overwritten to default qualifying values.

pub fn set_limiter(
    &mut self,
    page: &str,
    column: &str,
    limiter: &ValueLimiter,
    panic: bool
) -> CedResult<()>

Set a limiter to a column

Args

• page : Page name
• column : Target column name(index)
• limiter : A limiter to apply to column
• panic : Whether to panic if current value fails to qualify liimter. If not, every unqualified values are overwritten to default qualifying values.

pub fn get_row_count(&self, page: &str) -> CedResult<usize>

pub fn get_column_count(&self, page: &str) -> CedResult<usize>

pub fn last_row_index(&self, page: &str) -> CedResult<usize>

Get last row index

pub fn last_column_index(&self, page: &str) -> CedResult<usize>

Get last column index

pub fn get_page_as_string(&self, page: &str) -> CedResult<String>

Get virtual data as string form

pub fn get_cell(
    &self,
    page: &str,
    row_index: usize,
    column_index: usize
) -> CedResult<Option<&Value>>

Get cell from page

This fails when page or coordinate doesn’t exist

pub fn get_column(
    &self,
    page: &str,
    column_index: usize
) -> CedResult<Option<&Column>>

Get column from page

This fails when either page or column doesn’t exist

pub fn get_column_by_name(
    &self,
    page: &str,
    column_name: &str
) -> CedResult<Option<&Column>>

Get column from page by name

This fails when either page or column doesn’t exist

Trait Implementations

impl Default for Processor

fn default() -> Self

Returns the “default value” for a type.