Enum ExternalCompression 

pub enum ExternalCompression {
    Uncompressed,
    Gzip {
        level: Option<u32>,
    },
    Zstd {
        level: Option<u32>,
    },
}

Compression options for file that are expressed externally like CSV and NDJSON. Externally does not mean by an external tool, more that it doesn’t happen internally like it does for Parquet and IPC.

Compared to other formats like IPC and Parquet, compression is external.

Variants

Uncompressed

Gzip

Fields

level: Option<u32>

Zstd

Fields

level: Option<u32>

Implementations

impl ExternalCompression

pub fn file_suffix(self) -> Option<&'static str>

Returns the expected file suffix associated with the compression format.

pub fn try_from(value: &str, level: Option<u32>) -> PolarsResult<Self>

Trait Implementations

impl Clone for ExternalCompression

fn clone(&self) -> ExternalCompression

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExternalCompression

impl Debug for ExternalCompression

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

Formats the value using the given formatter.

impl Default for ExternalCompression

fn default() -> ExternalCompression

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalCompression

Available on crate feature serde only.

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ExternalCompression

impl Hash for ExternalCompression

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ExternalCompression

Available on crate feature dsl-schema only.

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 ExternalCompression

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ExternalCompression

Available on crate feature serde only.

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 ExternalCompression