Struct prettytable::Table
[−]
[src]
pub struct Table { /* fields omitted */ }
An owned printable table
Methods
impl Table
[src]
fn new() -> Table
Create an empty table
fn init(rows: Vec<Row>) -> Table
Create a table initialized with rows
fn from_csv_string(csv_s: &str) -> Result<Table>
Create a table from a CSV string
For more customisability use from_csv()
fn from_csv_file<P: AsRef<Path>>(csv_p: P) -> Result<Table>
Create a table from a CSV file
For more customisability use from_csv()
fn from_csv<R: Read>(reader: &mut Reader<R>) -> Table
Create a table from a CSV reader
fn set_format(&mut self, format: TableFormat)
Change the table format. Eg : Separators
fn get_format(&mut self) -> &mut TableFormat
Get a mutable reference to the internal format
fn get_column_num(&self) -> usize
Compute and return the number of column
fn len(&self) -> usize
Get the number of rows
fn is_empty(&self) -> bool
Check if the table is empty
fn set_titles(&mut self, titles: Row)
Set the optional title lines
fn unset_titles(&mut self)
Unset the title line
fn get_mut_row(&mut self, row: usize) -> Option<&mut Row>
Get a mutable reference to a row
fn get_row(&self, row: usize) -> Option<&Row>
Get an immutable reference to a row
fn add_row(&mut self, row: Row) -> &mut Row
Append a row in the table, transferring ownership of this row to the table and returning a mutable reference to the row
fn add_empty_row(&mut self) -> &mut Row
Append an empty row in the table. Return a mutable reference to this new row.
fn insert_row(&mut self, index: usize, row: Row) -> &mut Row
Insert row
at the position index
, and return a mutable reference to this row.
If index is higher than current numbers of rows, row
is appended at the end of the table
fn set_element(
&mut self,
element: &str,
column: usize,
row: usize
) -> Result<(), &str>
&mut self,
element: &str,
column: usize,
row: usize
) -> Result<(), &str>
Modify a single element in the table
fn remove_row(&mut self, index: usize)
Remove the row at position index
. Silently skip if the row does not exist
fn column_iter(&self, column: usize) -> ColumnIter
Return an iterator over the immutable cells of the column specified by column
fn column_iter_mut(&mut self, column: usize) -> ColumnIterMut
Return an iterator over the mutable cells of the column specified by column
fn row_iter(&self) -> Iter<Row>
Returns an iterator over immutable rows
fn row_iter_mut(&mut self) -> IterMut<Row>
Returns an iterator over mutable rows
fn print<T: Write + ?Sized>(&self, out: &mut T) -> Result<(), Error>
Print the table to out
fn print_term<T: Terminal + ?Sized>(&self, out: &mut T) -> Result<(), Error>
Print the table to terminal out
, applying styles when needed
fn print_tty(&self, force_colorize: bool)
Print the table to standard output. Colors won't be displayed unless
stdout is a tty terminal, or force_colorize
is set to true
.
In ANSI terminals, colors are displayed using ANSI escape characters. When for example the
output is redirected to a file, or piped to another program, the output is considered
as not beeing tty, and ANSI escape characters won't be displayed unless force colorize
is set to true
.
Panic
Panic if writing to standard output fails
fn printstd(&self)
Print the table to standard output. Colors won't be displayed unless
stdout is a tty terminal. This means that if stdout is redirected to a file, or piped
to another program, no color will be displayed.
To force colors rendering, use print_tty()
method.
Calling printstd()
is equivalent to calling print_tty(false)
Panic
Panic if writing to standard output fails
fn to_csv<W: Write>(&self, w: W) -> Result<Writer<W>>
Write the table to the specified writer.
fn to_csv_writer<W: Write>(&self, writer: Writer<W>) -> Result<Writer<W>>
Write the table to the specified writer.
This allows for format customisation.
Trait Implementations
impl Clone for Table
[src]
fn clone(&self) -> Table
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Debug for Table
[src]
impl Index<usize> for Table
[src]
type Output = Row
The returned type after indexing
fn index(&self, idx: usize) -> &Self::Output
The method for the indexing (container[index]
) operation
impl IndexMut<usize> for Table
[src]
fn index_mut(&mut self, idx: usize) -> &mut Self::Output
The method for the mutable indexing (container[index]
) operation
impl Display for Table
[src]
fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl<B: ToString, A: IntoIterator<Item = B>> FromIterator<A> for Table
[src]
fn from_iter<T>(iterator: T) -> Table where
T: IntoIterator<Item = A>,
T: IntoIterator<Item = A>,
Creates a value from an iterator. Read more
impl<T, A, B> From<T> for Table where
B: ToString,
A: IntoIterator<Item = B>,
T: IntoIterator<Item = A>,
[src]
B: ToString,
A: IntoIterator<Item = B>,
T: IntoIterator<Item = A>,
impl<'a> IntoIterator for &'a Table
[src]
type Item = &'a Row
The type of the elements being iterated over.
type IntoIter = Iter<'a, Row>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
impl<'a> IntoIterator for &'a mut Table
[src]
type Item = &'a mut Row
The type of the elements being iterated over.
type IntoIter = IterMut<'a, Row>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
Creates an iterator from a value. Read more
impl<'a> AsRef<TableSlice<'a>> for Table
[src]
fn as_ref(&self) -> &TableSlice<'a>
Performs the conversion.