Struct genie::Palette

pub struct Palette { /* fields omitted */ }

A Palette.

Implementations

impl Palette

pub fn new() -> Palette

Create an empty palette.

pub fn read_from(input: impl Read) -> Result<Palette, ReadPaletteError>

Read a palette from an input stream.

pub fn write_to(&self, output: impl Write) -> Result<(), Error>

Write a palette to an output stream.

pub fn into_inner(self) -> Vec<RGB<u8>>

Return the colours in a Vec so it can be manipulated.

It can later be wrapped back into a Palette instance using Palette::from(vec).

pub fn colors(&self) -> &[RGB<u8>]

Return the colours as a slice.

pub fn colors_mut(&mut self) -> &mut Vec<RGB<u8>>

Return the colours as a mutable vector.

pub fn len(&self) -> usize

Returns the number of colours in this palette.

pub fn is_empty(&self) -> bool

Returns true if this palette contains 0 colours.

pub fn add(&mut self, color: RGB<u8>)

Add a colour at the end of the palette.

pub fn to_bytes(&self) -> Vec<u8>

Serialize the palette to a byte vector.

Trait Implementations

impl Clone for Palette

fn clone(&self) -> Palette

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Palette

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

Formats the value using the given formatter.

impl Default for Palette

fn default() -> Palette

Create a palette with 256 colours, all black.

impl Eq for Palette

impl From<Vec<RGB<u8>>> for Palette

fn from(colors: Vec<RGB<u8>>) -> Palette

Create a palette from a vector of colours.

impl FromStr for Palette

type Err = ReadPaletteError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Palette, <Palette as FromStr>::Err>

Parse a palette from a UTF-8 string.

impl Index<PaletteIndex> for Palette

type Output = RGB<u8>

The returned type after indexing.

fn index(
    &self,
    index: PaletteIndex
) -> &<Palette as Index<PaletteIndex>>::Output

Get the colour at the given index.

impl IndexMut<PaletteIndex> for Palette

fn index_mut(
    &mut self,
    index: PaletteIndex
) -> &mut <Palette as Index<PaletteIndex>>::Output

Get the colour at the given index.

impl IntoIterator for Palette

type Item = RGB<u8>

The type of the elements being iterated over.

type IntoIter = IntoIter<RGB<u8>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Palette as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Palette

type Item = &'a RGB<u8>

The type of the elements being iterated over.

type IntoIter = Iter<'a, RGB<u8>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Palette as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<Palette> for Palette

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

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

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

This method tests for !=.

impl StructuralEq for Palette

impl StructuralPartialEq for Palette

impl ToString for Palette

fn to_string(&self) -> String

Converts the given value to a String.