Enum FileFormat 

pub enum FileFormat {
    JsonLines,
    JsonArray,
    Csv,
    Xml,
    Xlsx,
    Parquet,
    RawText,
    Avro,
    Orc,
}

How the bytes of one object are laid out.

The variants are the union of what the file connectors could previously read or write, so adopting this enum never removes a format from a connector that had it.

Variants

JsonLines

One JSON value per line (NDJSON). The default everywhere, because it is the only format that both streams and round-trips arbitrary JSON.

JsonArray

A single JSON array holding every record.

Csv

Delimited text. See CsvOptions.

Xml

XML. See XmlOptions.

Xlsx

An Excel workbook (.xlsx). See ExcelOptions.

Parquet

Apache Parquet — named for config, handled by each connector’s own Arrow path, never by decode/encode.

RawText

Unparsed text: one record per object, {"text": "<whole body>"}.

Avro

Apache Avro Object Container File. See AvroOptions. Read and write; decodes to records or, with arrow, straight to Arrow batches.

Orc

Apache ORC. See OrcOptions. Read-only — see the orc module for why there is no writer.

Implementations

impl FileFormat

pub fn extension(self) -> &'static str

The conventional file extension, used to name objects a sink creates when the user did not pick one.

pub fn requires_whole_object(self) -> bool

Whether the whole object must be in memory to produce the first record.

Callers use this to decide between a streaming read and a buffered one. It is a property of the format, not of the source: a JSON array has no record boundary until it is parsed, a zip-container workbook has its directory at the end, and an XML document is a tree.

pub fn is_container(self) -> bool

Whether the format is a self-describing binary container decoded by ContainerDecoder (Avro, ORC) rather than by decode per object.

pub fn is_writable(self) -> bool

Whether a sink can write this format through encode.

pub fn from_path(path: &str) -> Option<Self>

The format a file name’s extension names, looking through a trailing compression suffix (.gz, .gzip, .zst, .zstd), so export.csv.gz is CSV. None for an extension no format claims.

.json is a JSON array (a lone object is one record); .jsonl and .ndjson are JSON Lines; .tsv is not claimed, because its delimiter is an option rather than a format.

pub fn as_str(self) -> &'static str

The name used in config and error messages.

Trait Implementations

impl Clone for FileFormat

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileFormat

impl Debug for FileFormat

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

Formats the value using the given formatter.

impl Default for FileFormat

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileFormat

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileFormat

impl JsonSchema for FileFormat

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.

impl PartialEq for FileFormat

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileFormat