Skip to main content

LeopardMode

Enum LeopardMode 

Source
#[non_exhaustive]
pub enum LeopardMode { Disabled, AsNeeded, PreferGF16, PreferLeopard, }
Expand description

Controls optional automatic selection of a Leopard codec when the requested CodecFamily is Classic.

Auto-selection only takes effect on a byte-oriented field (where size_of::<Field::Elem>() == 1, i.e. the GF(2^8) field the Leopard codecs are built on); on any other field the mode is ignored and the codec stays Classic. When the caller sets an explicit non-Classic codec_family, this mode is likewise ignored — the explicit family wins.

The resolution, as a function of total = data + parity shards, mirrors the klauspost/reedsolomon New() behaviour:

totalAsNeededPreferLeopardPreferGF16
≤ 256ClassicLeopardGF8¹LeopardGF16
257..=65536LeopardGF16LeopardGF16LeopardGF16

¹ PreferLeopard selects LeopardGF8 only when total ≤ 256 and parity ≤ 128; otherwise it falls back to LeopardGF16.

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.
§

Disabled

Never auto-select Leopard. The codec behaves exactly as an explicit CodecFamily::Classic construction — byte-for-byte identical to releases before auto-activation existed. This is the default.

§

AsNeeded

Use Classic while it can represent the configuration (total ≤ 256), and automatically switch to LeopardGF16 once the shard count exceeds what GF(2^8) can address.

§

PreferGF16

Always use LeopardGF16 (for any supported shard count up to 65536).

§

PreferLeopard

Prefer a Leopard codec whenever possible: LeopardGF8 for small byte-friendly configurations (total ≤ 256 and parity ≤ 128), otherwise LeopardGF16.

Trait Implementations§

Source§

impl Clone for LeopardMode

Source§

fn clone(&self) -> LeopardMode

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 LeopardMode

Source§

impl Debug for LeopardMode

Source§

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

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

impl Default for LeopardMode

Source§

fn default() -> LeopardMode

Returns the “default value” for a type. Read more
Source§

impl Eq for LeopardMode

Source§

impl PartialEq for LeopardMode

Source§

fn eq(&self, other: &LeopardMode) -> 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 LeopardMode

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.