Skip to main content

TableLayout

Enum TableLayout 

Source
pub enum TableLayout {
    Kv,
    Db,
    Custom(CustomLayout),
}
Expand description

How the table stage interprets a row grid. Chosen per table source ((format, path, layout) / (format, path, sheet, layout) tuples), per formats entry ((format, [exts], layout)), or passed explicitly to parse_table; everything else uses the format’s default — Format::default_layout: kv for csv, db for excel/ods. Converts from a layout id string ("kv"/"kvf", "db") or a CustomLayout.

Variants§

§

Kv

key,value[,format] positional rows — one config entry per row. The default for csv.

§

Db

A database-style grid: the first (non-blank) row holds the keys, the second always the type ids (an empty cell = auto), every following row is one record. Parses to an array of one object per record: [[a,b],[i8,str],[4,x],[5,y]] → [{a:4,b:"x"},{a:5,b:"y"}]. Empty cells are omitted from their record (sparse tables give sparse objects). The default for the spreadsheet formats (excel/ods). A grid without a type row is a CustomLayout that inserts a row of auto cells after the header and delegates back to Db (see the xlsx-sheets example).

§

Custom(CustomLayout)

A user callback over the raw rows — see CustomLayout.

Implementations§

Source§

impl TableLayout

Source

pub fn from_id(id: &str) -> Option<TableLayout>

Look a layout up by its string id: kv (alias kvf) or db.

Source

pub fn id(&self) -> &str

The string id of this layout (a custom layout reports its own id).

Trait Implementations§

Source§

impl Clone for TableLayout

Source§

fn clone(&self) -> TableLayout

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TableLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TableLayout

Source§

fn default() -> TableLayout

Returns the “default value” for a type. Read more
Source§

impl From<&str> for TableLayout

Source§

fn from(id: &str) -> Self

Panics on an unknown id — this is config-time code. See TableLayout::from_id for the accepted spellings.

Source§

impl From<CustomLayout> for TableLayout

Source§

fn from(custom: CustomLayout) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for TableLayout

Source§

fn eq(&self, other: &TableLayout) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TableLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.