Struct TableInitOptions 

pub struct TableInitOptions {
    pub name: Option<String>,
    pub format: Option<TableReadFormat>,
    pub index: Option<String>,
    pub limit: Option<u32>,
    pub page_to_disk: Option<bool>,
    pub list_flatten: Option<ListFlatten>,
}

Options which impact the behavior of Client::table, as well as subsequent calls to Table::update.

Fields

name: Option<String>

format: Option<TableReadFormat>

index: Option<String>

This Table should use the column named by the index parameter as the index, which causes Table::update and Client::table input to either insert or update existing rows based on index column value equality.

limit: Option<u32>

This Table should be limited to limit rows, after which the earliest rows will be overwritten (where earliest is defined as relative to insertion order).

page_to_disk: Option<bool>

Back this Table’s canonical data with the on-disk storage backend instead of memory. On native targets this is a memory-mapped file; on WASM it is OPFS (Worker only). Defaults to in-memory.

list_flatten: Option<ListFlatten>

How Arrow LIST and JSON Array columns are ingested. zip (the default) and cartesian expand a row into one row per list element, and are incompatible with index, as the rows of an expansion repeat their index. stringify encodes each list as a JSON array in a single string column instead.

Implementations

impl TableInitOptions

pub fn set_name<D: Display>(&mut self, name: D)

Trait Implementations

impl Clone for TableInitOptions

fn clone(&self) -> TableInitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableInitOptions

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

Formats the value using the given formatter.

impl Default for TableInitOptions

fn default() -> TableInitOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TableInitOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TableInitOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for TableInitOptions

type WithoutGenerics = TableInitOptions

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = TableInitOptions

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.