Enum Overlap

pub enum Overlap {
    Less,
    Greater,
    Equal,
    Narrow,
    Wide,
    WideLess,
    WideGreater,
}

An Overlap is the result of a comparison between two ranges, the equivalent of Ordering for hierarchical data.

Variants

Less

A lack of overlap where the compared range is entirely less than another

Greater

A lack of overlap where the compared range is entirely greater than another

Equal

An overlap where the compared range is identical to another

Narrow

An overlap where the compared range is narrower than another

Wide

An overlap where the compared range is wider than another on both sides

WideLess

An overlap where the compared range is wider than another with a lesser start and end point

WideGreater

An overlap where the compared range is wider than another with a greater start and end point

Implementations

impl Overlap

pub fn then(self, other: Self) -> Self

Return the narrowest Overlap which contains both self and other. Examples:

use collate::Overlap;
assert_eq!(Overlap::Narrow.then(Overlap::Less), Overlap::WideLess);
assert_eq!(Overlap::WideLess.then(Overlap::WideGreater), Overlap::Wide);
assert_eq!(Overlap::Less.then(Overlap::Greater), Overlap::Wide);
assert_eq!(Overlap::Less.then(Overlap::Less), Overlap::Less);

Trait Implementations

impl Clone for Overlap

fn clone(&self) -> Overlap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Overlap

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

Formats the value using the given formatter.

impl From<Ordering> for Overlap

fn from(order: Ordering) -> Self

Converts to this type from the input type.

impl PartialEq for Overlap

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

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

impl Eq for Overlap

impl StructuralPartialEq for Overlap