Struct Draft 

pub struct Draft { /* private fields */ }

Structure holding all elements of a draft

Implementations

impl Draft

pub fn new( shaft_count: u32, tie_up_create: TieUpCreate, rise_sink: RiseSink, ) -> Self

Create an empty draft with the given options

pub fn threading(&self) -> &Threading

Get the threading

pub fn treadling_info(&self) -> &TreadlingInfo

Get the treadling

pub fn tie_up(&self) -> &TieUpKind

Get the tie-up

pub fn make_rising(&mut self)

Make rising shaft

pub fn make_sinking(&mut self)

Make sinking shaft

pub fn make_lift_plan(&mut self) -> bool

Goes from a treadling to a lift plan. Returns false if already a lift plan, true if conversion happened

pub fn max_shaft(&self) -> (WeavingAxis, u32)

Max shaft used in threading or treadling

pub fn set_shaft_count( &mut self, shaft_count: u32, ) -> Result<(), (WeavingAxis, u32)>

Sets shaft count on threading and treadling. Only succeeds when non-destructive

Errors

If shafts greater than the given count are in use, returns an error with the max used shaft and the axis it’s used on

Panics

If shaft count is 0

pub fn splice_threading<R>( &mut self, range: R, replace_with: &[u32], ) -> Result<Vec<u32>, usize>

where R: RangeBounds<usize>,

Calls Threading::splice

Errors

See Threading::splice

pub fn push_threading(&mut self, shaft: u32) -> Result<(), u32>

Adds a new thread to teh end of the threading

Errors

Returns the shaft if greater than shaft count

pub fn insert_threading( &mut self, shaft: Shaft, index: usize, ) -> Result<(), Shaft>

Insert a thread in the threading at the given index, shifting the later threads

Panics

If index is greater than length

Errors

If shaft is greater than shaft_count

pub fn try_insert_threading( &mut self, shaft: Shaft, index: usize, ) -> Result<Result<(), Shaft>, usize>

Insert a thread at the given index, shifting later threads

Errors

Returns the current length if index is greater than length

pub fn remove_threading(&mut self, index: usize) -> Shaft

Remove the thread at the given index, returning it as a Shaft

Panics

If index is out of bounds

pub fn get_from_threading(&self, index: usize) -> Option<&u32>

Get threading shaft at an index

pub fn put_threading(&mut self, index: usize, shaft: Shaft) -> Shaft

Overwrite thread at given index, returns old thread value

Panics

If index is out of bounds

pub fn try_put_threading( &mut self, index: usize, shaft: Shaft, ) -> Result<Option<Shaft>, usize>

Overwrite thread at given index. Returns replaced shaft, or none if inserting at the end

Errors

Returns current length if index out of bounds

pub fn flip_threading_vert(&mut self)

See Threading::flip_vertical

pub fn mirror_threading(&mut self)

See Threading::mirror

pub fn flip_threading_horiz(&mut self)

See Threading::reverse

pub fn push_single_treadling(&mut self, treadle: u32) -> Result<(), u32>

Add a new pick at the end using just the given treadle

Errors

If treadle is higher than number of shafts, returns treadle

pub fn push_treadling(&mut self, treadles: HashSet<u32>) -> Result<(), u32>

Add a new pick at the end using all given treadles/shafts

Errors

If any treadle is over the number of treadles/shafts, returns that value

pub fn toggle_treadle( &mut self, index: usize, treadle: Treadle, ) -> Result<bool, u32>

Toggle treadle at given index. Return true if treadle has been toggled on, false if toggled off

Errors

If treadle is invalid

Panics

If index is out of bounds

pub fn insert_treadle( &mut self, index: usize, treadles: HashSet<u32>, ) -> Result<(), u32>

Inserts treadling at given index

Errors

If any treadles are invalid

Panics

If index is out of bounds

pub fn splice_treadling<R>( &mut self, range: R, replace_with: Vec<HashSet<u32>>, ) -> Result<Vec<HashSet<u32>>, u32>

where R: RangeBounds<usize>,

Based on Vec::splice, it splices the given sequence into the given range. It validates that the elements in replace_with are inside the shaft bounds, and it returns the replaced elements.

Errors

If an element in replace_with is larger than the shaft count, returns index of first out-of-bounds element

pub fn put_treadling( &mut self, index: usize, treadles: HashSet<u32>, ) -> Result<Option<HashSet<u32>>, u32>

Overwrites the treadling at the given index with the new treadles

Errors

If treadling is invalid

Panics

If index is greater than the length of the treadling

pub fn yarn_palette(&self) -> &YarnPalette

Get yarn palette

pub fn weft_yarns(&self) -> &YarnSequence

Get weft yarns

pub fn warp_yarns(&self) -> &YarnSequence

Get warp yarns

pub fn set_weft_yarn_repeat<T>(&mut self, yarns: T)

where T: IntoIterator<Item = Yarn>,

Set the repeat of weft yarns

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

set weft yarn repeat offset

pub fn set_weft_yarn(&mut self, index: usize, yarn: Yarn)

set weft yarn at index

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

Get weft yarn at index. Returns None if not set via repeat or directly

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

Get weft yarn at index

Panics

If yarn is not set via repeat or directly

pub fn set_warp_yarn_repeat<T>(&mut self, yarns: T)

where T: IntoIterator<Item = Yarn>,

Set the repeat of weft yarns

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

set warp yarn repeat offset

pub fn set_warp_yarn(&mut self, index: usize, yarn: Yarn)

set warp yarn at index

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

Get warp yarn at index. Returns None if not set via repeat or directly

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

Get warp yarn at index

Panics

If yarn is not set via repeat or directly

Trait Implementations

impl Clone for Draft

fn clone(&self) -> Draft

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Draft

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

Formats the value using the given formatter.

impl PartialEq for Draft

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