Struct YarnRepeat 

pub struct YarnRepeat { /* private fields */ }

Repeating sequence of yarns used in the warp or weft

Implementations

impl YarnRepeat

pub fn new() -> Self

Empty yarn repeat

pub fn set_sequence(&mut self, sequence: &[Rc<Yarn>])

Set the repat

pub fn set_offset(&mut self, offset: usize)

Set the offset

pub fn try_get(&self, index: usize) -> Option<&Rc<Yarn>>

Gets the appropriate yarn for the given index, returns None if the sequence is empty

Examples

let mut seq = YarnRepeat::new();
assert_eq!(seq.try_get(1), None);

let yarn_1 = Rc::new(Yarn::default());
let mut yarn_2 = Yarn::default();
yarn_2.set_color(Color(255,255,255));
let yarn_2 = Rc::new(yarn_2);
seq.set_sequence(&[Rc::clone(&yarn_1), Rc::clone(&yarn_2)]);

assert_eq!(seq.try_get(3).unwrap(), &yarn_2);

seq.set_offset(1);
assert_eq!(seq.try_get(3).unwrap(), &yarn_1);

pub fn get(&self, index: usize) -> &Rc<Yarn>

Gets the appropriate yarn for the given index

Panics

If the sequence is empty

pub fn offset(&self) -> usize

get offset

pub fn sequence(&self) -> &Vec<Rc<Yarn>>

get sequence

Trait Implementations

impl Clone for YarnRepeat

fn clone(&self) -> YarnRepeat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for YarnRepeat

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

Formats the value using the given formatter.

impl Default for YarnRepeat

fn default() -> YarnRepeat

Returns the “default value” for a type.

impl PartialEq for YarnRepeat

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