Struct vimwiki::Table

pub struct Table<'a> {
    pub centered: bool,
    // some fields omitted
}

Fields

centered: bool

Represents whether or not the table is centered

Implementations

impl<'_> Table<'_>

pub fn to_borrowed(&self) -> Table<'_>

pub fn into_owned(self) -> Table<'static>

impl<'a> Table<'a>

pub fn new<I>(cells: I, centered: bool) -> Table<'a> where
    I: IntoIterator<Item = (CellPos, Located<Cell<'a>>)>, 

pub fn header_rows(&self) -> HeaderRows<'_, 'a>

Returns an iterator over all rows that are considered header rows, which is all rows leading up to a divider row. If there is no divider row, then there are no header rows

pub fn body_rows(&self) -> BodyRows<'_, 'a>

Returns an iterator over all rows that are considered body rows, which is all rows following a divider row. If there is no divider row in the table, then all rows are considered body rows

pub fn has_header_rows(&self) -> bool

Returns true if contains header rows

pub fn has_body_rows(&self) -> bool

Returns true if contains body rows

pub fn has_divider_row(&self) -> bool

Returns true if the table contains a divider row

pub fn get_divider_row_index(&self) -> Option<usize>

Returns the row index representing the divider row of the table (separation between header and body) if it exists

pub fn get_column_alignment(&self, col: usize) -> ColumnAlign

Returns the alignment of the specified column within the table

NOTE: This will always return an alignment, even if the column does not exist, by using the default column alignment

pub fn row_cnt(&self) -> usize

Returns the total rows contained in the table

pub fn col_cnt(&self) -> usize

Returns the total columns contained in the table

pub fn len(&self) -> usize

Returns the total cells (rows * columns) contained in the table

pub fn is_empty(&self) -> bool

Returns true if the total cells (rows * columns) contained in the table is zero

pub fn as_data(&self) -> &HashMap<CellPos, Located<Cell<'a>>, RandomState>

Returns raw table cell data as a reference to the hashmap

pub fn rows(&self) -> Rows<'_, 'a>

Returns an iterator of refs through all rows in the table

pub fn row(&self, idx: usize) -> Row<'_, 'a>

Returns an iterator of refs through a specific row in the table

pub fn into_row(self, idx: usize) -> IntoRow<'a>

Consumes the table and returns an iterator through a specific row in the table

pub fn columns(&self) -> Columns<'_, 'a>

Returns an iterator of refs through all columns in the table

pub fn column(&self, idx: usize) -> Column<'_, 'a>

Returns an iterator of refs through a specific column in the table

pub fn into_column(self, idx: usize) -> IntoColumn<'a>

Consumes the table and returns an iterator through a specific column in the table

pub fn cells(&self) -> Cells<'_, 'a>

Returns an iterator of refs through all cells in the table, starting from the first row, iterating through all cells from beginning to end, and then moving on to the next row

pub fn into_cells(self) -> IntoCells<'a>

Consumes the table and returns an iterator through all cells in the table, starting from the first row, iterating through all cells from beginning to end, and then moving on to the next row

pub fn get_cell(&self, row: usize, col: usize) -> Option<&Located<Cell<'a>>>

Returns reference to the cell found at the specified row and column

pub fn get_mut_cell(
    &mut self,
    row: usize,
    col: usize
) -> Option<&mut Located<Cell<'a>>>

Returns mut reference to the cell found at the specified row and column

pub fn get_cell_rowspan(&self, row: usize, col: usize) -> usize

Returns the cell’s rowspan, which is the number of rows (including itself) that the cell spans. 1 means that the cell only spans its starting row whereas >1 indicates it is 1 or more rows below its starting row

Returns 0 for a non-content cell or a cell that doesn’t exist

pub fn get_cell_colspan(&self, row: usize, col: usize) -> usize

Returns the cell’s colspan, which is the number of columns (including itself) that the cell spans. 1 means that the cell only spans its starting column whereas >1 indicates it is 1 or more columns after its starting column

Returns 0 for a non-content cell or a cell that doesn’t exist

Trait Implementations

impl<'a> Clone for Table<'a>

pub fn clone(&self) -> Table<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Table<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Table<'a>

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Table<'a>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<Table<'a>> for BlockElement<'a>

pub fn from(original: Table<'a>) -> BlockElement<'a>

Performs the conversion.

impl<'a> From<Table<'a>> for Element<'a>

pub fn from(value: Table<'a>) -> Element<'a>

Performs the conversion.

impl<'a> IntoChildren for Table<'a>

type Child = Located<InlineElement<'a>>

The type of child contained within

pub fn into_children(self) -> Vec<<Table<'a> as IntoChildren>::Child, Global>

Returns a vec of children contained within

impl<'a> IntoIterator for Table<'a>

type Item = <HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <Table<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, '__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime mut Table<'a>

type Item = <&'__deriveMoreLifetime mut HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'__deriveMoreLifetime mut HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(
    self
) -> <&'__deriveMoreLifetime mut Table<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a, '__deriveMoreLifetime> IntoIterator for &'__deriveMoreLifetime Table<'a>

type Item = <&'__deriveMoreLifetime HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'__deriveMoreLifetime HashMap<CellPos, Located<Cell<'a>>, RandomState> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

pub fn into_iter(
    self
) -> <&'__deriveMoreLifetime Table<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq<Table<'a>> for Table<'a>

pub fn eq(&self, other: &Table<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Table<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Table<'a>

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> StrictEq<Table<'a>> for Table<'a>

pub fn strict_eq(&self, other: &Table<'a>) -> bool

Performs strict_eq on cells and centered status

fn strict_ne(&self, other: &Rhs) -> bool

impl<'a> Eq for Table<'a>

impl<'a> StructuralEq for Table<'a>

impl<'a> StructuralPartialEq for Table<'a>