Struct FindValueParams 

pub struct FindValueParams {

    pub workbook_or_fork_id: WorkbookId,
    pub query: String,
    pub label: Option<String>,
    pub mode: Option<FindMode>,
    pub match_mode: Option<MatchMode>,
    pub case_sensitive: bool,
    pub sheet_name: Option<String>,
    pub region_id: Option<u32>,
    pub table_name: Option<String>,
    pub value_types: Option<Vec<ValueTypeFilter>>,
    pub search_headers_only: bool,
    pub direction: Option<LabelDirection>,
    pub limit: u32,
    pub offset: Option<u32>,
    pub context: Option<FindContext>,
    pub context_width: Option<u32>,
}

Fields

workbook_or_fork_id: WorkbookId

Workbook ID or fork ID

query: String

Value or pattern to search for

label: Option<String>

For label mode: find cells near this label text

mode: Option<FindMode>

Search mode: “value” (default) or “label” for key-value lookups

match_mode: Option<MatchMode>

Match mode for text comparison

case_sensitive: bool

Case-sensitive matching (default: false)

sheet_name: Option<String>

Limit search to specific sheet

region_id: Option<u32>

Limit search to specific detected region

table_name: Option<String>

Limit search to specific named table

value_types: Option<Vec<ValueTypeFilter>>

Filter by value types

search_headers_only: bool

Only search in header rows (default: false)

direction: Option<LabelDirection>

For label mode: direction to look for value

limit: u32

Maximum matches to return (default: 50)

offset: Option<u32>

Offset for pagination

context: Option<FindContext>

Context to include with matches

context_width: Option<u32>

Number of cells in each direction for context (default: 3)

Trait Implementations

impl Debug for FindValueParams

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

Formats the value using the given formatter.

impl Default for FindValueParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FindValueParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FindValueParams

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.