Struct PaletteSize 

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

This type is used to specify the number of colors in a palette.

This is a simple new type wrapper around u16 with the invariant that it must be in the range 1..=256 specified by PaletteSize::MIN and PaletteSize::MAX.

Examples

A PaletteSize can be created from a u8, u16, usize, NonZeroU8, or NonZeroU16. To do so, use either:

• The clamping functions like from_usize_clamped.
• The TryFrom trait implementations for PaletteSize.
  • There are also const compatible functions like try_from_u16.

You can also use the PaletteSize::MIN or PaletteSize::MAX constants.

let size: PaletteSize = 64u16.try_into()?;
assert_eq!(size, 64u16);
assert_eq!(PaletteSize::try_from(16usize)?, 16usize);
assert_eq!(PaletteSize::try_from_u16(256), Some(PaletteSize::MAX));
assert_eq!(PaletteSize::try_from_u16(1024), None);
assert_eq!(PaletteSize::from_u16_clamped(1024), PaletteSize::MAX);
assert_eq!(PaletteSize::from_nz_u8(NonZeroU8::MIN), PaletteSize::MIN);

Implementations

impl PaletteSize

pub const MIN: Self

The smallest possible palette size, which is 1.

pub const MAX: Self

The largest possible palette size, which is 256.

pub const fn as_nz_u16(&self) -> NonZeroU16

Returns a PaletteSize as a NonZeroU16.

pub const fn as_u16(&self) -> u16

Returns a PaletteSize as a u16.

pub const fn as_usize(&self) -> usize

Returns a PaletteSize as a usize.

pub const fn try_from_nz_u16(value: NonZeroU16) -> Option<Self>

Create a PaletteSize from a NonZeroU16, returning None if the provided value is greater than PaletteSize::MAX.

pub const fn try_from_u16(value: u16) -> Option<Self>

Create a PaletteSize from a u16, returning None if the provided value is less than PaletteSize::MIN or greater than PaletteSize::MAX.

pub const fn try_from_usize(value: usize) -> Option<Self>

Create a PaletteSize from a usize, returning None if the provided value is less than PaletteSize::MIN or greater than PaletteSize::MAX.

pub const fn from_nz_u16_clamped(value: NonZeroU16) -> Self

Create a PaletteSize from a NonZeroU16, clamping the provided value to a maximum of PaletteSize::MAX.

pub const fn from_u16_clamped(value: u16) -> Self

Create a PaletteSize from a u16, clamping the provided value to the range specified by PaletteSize::MIN and PaletteSize::MAX.

pub const fn from_usize_clamped(value: usize) -> Self

Create a PaletteSize from a usize, clamping the provided value to the range specified by PaletteSize::MIN and PaletteSize::MAX.

pub const fn try_from_u8(value: u8) -> Option<Self>

Create a PaletteSize from a u8, returning None if the provided value is less than PaletteSize::MIN.

pub const fn from_nz_u8(len: NonZeroU8) -> Self

Create a PaletteSize from a NonZeroU8.

pub const fn from_u8_clamped(len: u8) -> Self

Create a PaletteSize from a u8, clamping the provided value to a minimum of PaletteSize::MIN.

Trait Implementations

impl Clone for PaletteSize

fn clone(&self) -> PaletteSize

Returns a duplicate 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 Display for PaletteSize

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

Formats the value using the given formatter.

impl From<NonZero<u8>> for PaletteSize

fn from(value: NonZeroU8) -> Self

Converts to this type from the input type.

impl From<PaletteSize> for NonZeroU16

fn from(size: PaletteSize) -> Self

Converts to this type from the input type.

impl From<PaletteSize> for u16

fn from(size: PaletteSize) -> Self

Converts to this type from the input type.

impl From<PaletteSize> for usize

fn from(size: PaletteSize) -> 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,

Restrict a value to a certain interval.

impl PartialEq<NonZero<u16>> for PaletteSize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<PaletteSize> for NonZeroU16

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<PaletteSize> for u16

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<PaletteSize> for usize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<u16> for PaletteSize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<usize> for PaletteSize

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for PaletteSize

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

Tests for self and other values to be equal, and is used by ==.

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<NonZero<u16>> for PaletteSize

type Error = PaletteSizeFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u16> for PaletteSize

type Error = PaletteSizeFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u8> for PaletteSize

type Error = PaletteSizeFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for PaletteSize

type Error = PaletteSizeFromIntError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for PaletteSize

impl Eq for PaletteSize

impl StructuralPartialEq for PaletteSize