Struct InspectFileParams 

pub struct InspectFileParams {
    pub path: String,
    pub sample_rows: Option<u32>,
    pub json_extract_path: Option<String>,
}

Parameters for the inspect_file tool.

Dry-run a file against the same schema inference + numeric-widening pipeline that load_file uses, returning the inferred schema plus per-column diagnostics. Call this before load_file whenever you are unsure about types — especially for wide CSVs with large numbers, mixed integer/float columns, or values that only appear near the end of the file. Use the returned type + min / max to construct an explicit schema override for the subsequent load_file / load_data call.

Fields

path: String

Absolute path to the CSV, Parquet, or Arrow IPC file to inspect. Nothing is written to Hyper and no engine is started.

sample_rows: Option<u32>

Maximum number of sample rows / values per column to return (default 5, max 50). Useful for checking that an override would produce the expected types before ingesting a large file.

json_extract_path: Option<String>

Optional dot-separated path to extract a nested data array from a JSON file before inspecting. See LoadFileParams::json_extract_path for the full path syntax and stringified-JSON handling.

Trait Implementations

impl Debug for InspectFileParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InspectFileParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InspectFileParams

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.