Struct ReadTableParams 

pub struct ReadTableParams {

    pub workbook_or_fork_id: WorkbookId,
    pub sheet_name: Option<String>,
    pub table_name: Option<String>,
    pub region_id: Option<u32>,
    pub range: Option<String>,
    pub header_row: Option<u32>,
    pub header_rows: Option<u32>,
    pub columns: Option<Vec<String>>,
    pub filters: Option<Vec<TableFilter>>,
    pub sample_mode: Option<SampleMode>,
    pub limit: Option<u32>,
    pub offset: Option<u32>,
    pub format: Option<TableOutputFormat>,
    pub include_headers: Option<bool>,
    pub include_types: Option<bool>,
}

Fields

workbook_or_fork_id: WorkbookId

Workbook ID or fork ID

sheet_name: Option<String>

Sheet name (uses first sheet if omitted)

table_name: Option<String>

Read from a named Excel table

region_id: Option<u32>

Read from a detected region by ID (from sheet_overview)

range: Option<String>

A1-style range (e.g., “A1:D100”)

header_row: Option<u32>

1-based row number for headers (auto-detected if omitted)

header_rows: Option<u32>

Number of header rows for multi-row headers (default: 1)

columns: Option<Vec<String>>

Limit to specific columns by letter (e.g., [“A”, “C”, “D”])

filters: Option<Vec<TableFilter>>

Row filters to apply

sample_mode: Option<SampleMode>

Sampling mode for selecting rows

limit: Option<u32>

Maximum rows to return

offset: Option<u32>

Offset for pagination; use next_offset from previous response

format: Option<TableOutputFormat>

Output format: “csv” (default), “values” (arrays), or “json” (typed CellValue)

include_headers: Option<bool>

Include header row in output (default: true for csv)

include_types: Option<bool>

Include column type information (default: false)

Trait Implementations

impl Debug for ReadTableParams

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

Formats the value using the given formatter.

impl Default for ReadTableParams

fn default() -> ReadTableParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReadTableParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReadTableParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.