Struct YarnPalette 

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

Palette of yarns to be used in the weaving

Implementations

impl YarnPalette

pub fn new() -> YarnPalette

Construct a new YarnPalette

pub fn len(&self) -> usize

Number of yarns

pub fn is_empty(&self) -> bool

Is the palette empty

pub fn remove_unused_yarns(&mut self) -> Vec<Yarn>

Removes yarns that are not used outside the palette and returns a Vec of the removed yarns

Examples

let mut palette = YarnPalette::new();
palette.use_yarn(Yarn::default());
assert_eq!(palette.remove_unused_yarns(), vec![Yarn::default()]);
assert_eq!(palette.len(), 0);

let yarn = palette.use_yarn(Yarn::default());
assert_eq!(palette.remove_unused_yarns(), vec![]);
assert_eq!(Rc::strong_count(&yarn), 2);

pub fn use_yarn(&mut self, yarn: Yarn) -> Rc<Yarn>

Adds yarn to palette if not there. Returns reference to yarn owned by palette

pub fn use_yarns<T>(&mut self, yarns: T) -> Vec<Rc<Yarn>>

where T: IntoIterator<Item = Yarn>,

Add multiple yarns to the palette. Returned Vec is in the same order as the input

pub fn iter(&self) -> Iter<'_, Rc<Yarn>>

Borrowing iterator across yarns

Trait Implementations

impl Clone for YarnPalette

fn clone(&self) -> YarnPalette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YarnPalette

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

Formats the value using the given formatter.

impl Default for YarnPalette

fn default() -> YarnPalette

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a YarnPalette

type Item = &'a Rc<Yarn>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Rc<Yarn>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for YarnPalette

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