Struct LineSegment 

pub struct LineSegment { /* private fields */ }

A straight line between two different points

Implementations

impl LineSegment

pub fn try_new( start: ICoord, end: ICoord, ) -> Result<Self, StartAndEndAreTheSame>

pub fn new(start: ICoord, end: ICoord) -> Self

Creates a new LineSegment panicking if start and end are the same

pub fn start(&self) -> ICoord

pub fn end(&self) -> ICoord

pub fn delta(&self) -> ICoord

pub fn num_steps(&self) -> u32

pub fn num_cardinal_steps(&self) -> u32

pub fn reverse(&self) -> Self

pub fn infinite_iter(&self) -> InfiniteIter

pub fn infinite_cardinal_iter(&self) -> InfiniteCardinalIter

pub fn config_infinite_iter(&self, config: InfiniteConfig) -> InfiniteIter

pub fn config_infinite_cardinal_iter( &self, config: InfiniteConfig, ) -> InfiniteCardinalIter

pub fn iter(&self) -> Iter

Iterator over all coordinates allowing ordinal steps which begins on the start coordinate and ends with the end coordinate (inclusively)

pub fn cardinal_iter(&self) -> CardinalIter

Iterator over all coordinates allowing only cardinal steps which begins on the start coordinate and ends with the end coordinate (inclusively)

pub fn config_iter(&self, config: Config) -> Iter

pub fn config_cardinal_iter(&self, config: Config) -> CardinalIter

pub fn infinite_node_iter(&self) -> InfiniteNodeIter

pub fn infinite_cardinal_node_iter(&self) -> InfiniteCardinalNodeIter

pub fn config_infinite_node_iter( &self, config: InfiniteConfig, ) -> InfiniteNodeIter

pub fn config_infinite_cardinal_node_iter( &self, config: InfiniteConfig, ) -> InfiniteCardinalNodeIter

pub fn node_iter(&self) -> NodeIter

pub fn cardinal_node_iter(&self) -> CardinalNodeIter

pub fn config_node_iter(&self, config: Config) -> NodeIter

pub fn config_cardinal_node_iter(&self, config: Config) -> CardinalNodeIter

Trait Implementations

impl Clone for LineSegment

fn clone(&self) -> LineSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineSegment

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

Formats the value using the given formatter.

impl Hash for LineSegment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LineSegment

fn cmp(&self, other: &LineSegment) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LineSegment

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

fn partial_cmp(&self, other: &LineSegment) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for LineSegment

impl Eq for LineSegment

impl StructuralPartialEq for LineSegment