Skip to main content

CompressionType

Enum CompressionType 

Source
#[non_exhaustive]
#[repr(u8)]
pub enum CompressionType { None = 0, Gzip = 1, Snappy = 2, Lz4 = 3, Zstd = 4, }
Expand description

Codec identifier matching the lowest three bits of Kafka’s record-batch attribute byte.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

None = 0

§

Gzip = 1

§

Snappy = 2

§

Lz4 = 3

§

Zstd = 4

Implementations§

Source§

impl CompressionType

Source

pub fn from_attribute_bits(b: u8) -> Option<Self>

Decode the lowest three bits of a Kafka record-batch attribute byte.

The method returns None for codec ids outside 0..=4.

Source

pub fn as_attribute_bits(self) -> u8

Encode this codec into the lowest three bits of an attribute byte.

Source

pub const fn name(self) -> &'static str

The codec name that Kafka uses in compression.type.

Source

pub const fn default_level(self) -> Option<i32>

Kafka’s default compression level of the codec (CompressionType.defaultLevel), or None when the codec has no levels.

Source

pub const fn min_level(self) -> Option<i32>

Kafka’s lowest compression level of the codec (CompressionType.minLevel), or None when the codec has no levels.

Source

pub const fn max_level(self) -> Option<i32>

Kafka’s highest compression level of the codec (CompressionType.maxLevel), or None when the codec has no levels.

Source

pub fn check_level(self, level: i32) -> Result<(), CompressionError>

Check level as Kafka’s CompressionType.levelValidator does (KIP-390).

Gzip accepts 1 to 9, and also -1, which is the zlib default. Lz4 and zstd accept their range only.

§Errors

Returns CompressionError::InvalidLevel with Kafka’s message when the level is outside the range, or when the codec has no levels.

Trait Implementations§

Source§

impl Clone for CompressionType

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CompressionType

Source§

impl Debug for CompressionType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CompressionType

Source§

impl Hash for CompressionType

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CompressionType

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CompressionType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.