Struct TreadlingInfo 

pub struct TreadlingInfo { /* private fields */ }

The treadling or lift plan for a draft, also includes the tie-up and whether the loom is rising or sinking shed

Implementations

impl TreadlingInfo

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

Construct new treadling

Panics

If shaft or treadle count is 0

pub fn shaft_count(&self) -> u32

Get the shaft count

pub fn max_shaft_used(&self) -> u32

Returns max shaft used. If this is a direct tie-up, it’s the max shaft in the lift plan. If it’s an indirect tie-up, it’s the max shaft used in the tie-up, even if no picks use a treadle tied to that shaft

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

Non-destructively sets shaft count

Errors

If shaft_count is less than the max shaft used, returns max shaft

pub fn tie_up(&self) -> &TieUpKind

Get the tie-up info

pub fn treadle_count(&self) -> u32

Get the treadle count. Returns the shaft count if directly tied up

pub fn rise_sink(&self) -> RiseSink

Whether the treadling is for a rising shaft or sinking shaft loom

pub fn len(&self) -> usize

Number of picks in the treadling

pub fn is_empty(&self) -> bool

Is the treadling empty

pub fn push_single(&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(&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( &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<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( &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 make_rising(&mut self)

Convert in place to a rising shaft treadling

pub fn make_sinking(&mut self)

Convert in place to a sinking shaft treadling

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 invert(&mut self)

Switch from rising to sinking or vice versa

Trait Implementations

impl Clone for TreadlingInfo

fn clone(&self) -> TreadlingInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TreadlingInfo

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

Formats the value using the given formatter.

impl Default for TreadlingInfo

fn default() -> Self

Returns the “default value” for a type.

impl Index<usize> for TreadlingInfo

type Output = HashSet<u32>

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for TreadlingInfo

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