Struct quantette::PaletteSize

pub struct PaletteSize(/* private fields */);

This type is used to specify the (maximum) number of colors to include in a palette.

This is a simple new type wrapper around u16 with the invariant that it must be less than or equal to MAX_COLORS.

If a PaletteSize of 0 is provided to a quantization function, an empty QuantizeOutput will be returned.

Examples

Use into to create PaletteSizes from u8s. For u16s, use try_into or PaletteSize::from_clamped. You can also use the PaletteSize::MAX constant.

From a u8:

let size = PaletteSize::from(16);

From a u16:

let size: PaletteSize = 128u16.try_into()?;
let size = PaletteSize::from_clamped(1024);

Implementations

impl PaletteSize

pub const MAX: Self = _

The maximum supported palette size (given by MAX_COLORS).

pub const fn into_inner(self) -> u16

Gets the inner u16 value.

pub fn from_clamped(value: u16) -> Self

Creates a PaletteSize by clamping the given u16 to be less than or equal to MAX_COLORS.

Trait Implementations

impl Clone for PaletteSize

fn clone(&self) -> PaletteSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaletteSize

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

Formats the value using the given formatter.

impl Default for PaletteSize

fn default() -> Self

Returns the “default value” for a type.

impl Display for PaletteSize

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

Formats the value using the given formatter.

impl From<PaletteSize> for u16

fn from(val: PaletteSize) -> Self

Converts to this type from the input type.

impl From<u8> for PaletteSize

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for PaletteSize

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 Ord for PaletteSize

fn cmp(&self, other: &PaletteSize) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for PaletteSize

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for PaletteSize

fn partial_cmp(&self, other: &PaletteSize) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<u16> for PaletteSize

type Error = AboveMaxLen<u16>

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PaletteSize

impl Eq for PaletteSize

impl StructuralPartialEq for PaletteSize