Struct bio::utils::Interval

pub struct Interval<N: Ord + Clone>(_);

An Interval wraps the std::ops::Range from the stdlib and is defined by a start and end field where end should be >= start.

Implementations

impl<N: Ord + Clone> Interval<N>

pub fn new(r: Range<N>) -> Result<Interval<N>, IntervalError>

Construct a new Interval from the given Range. Will return Err if end < start.

Methods from Deref<Target = Range<N>>

pub fn contains<U>(&self, item: &U) -> boolwhere
    Idx: PartialOrd<U>,
    U: PartialOrd<Idx> + ?Sized,

Returns true if item is contained in the range.

Examples

assert!(!(3..5).contains(&2));
assert!( (3..5).contains(&3));
assert!( (3..5).contains(&4));
assert!(!(3..5).contains(&5));

assert!(!(3..3).contains(&3));
assert!(!(3..2).contains(&3));

assert!( (0.0..1.0).contains(&0.5));
assert!(!(0.0..1.0).contains(&f32::NAN));
assert!(!(0.0..f32::NAN).contains(&0.5));
assert!(!(f32::NAN..1.0).contains(&0.5));

pub fn is_empty(&self) -> bool

Returns true if the range contains no items.

Examples

assert!(!(3..5).is_empty());
assert!( (3..3).is_empty());
assert!( (3..2).is_empty());

The range is empty if either side is incomparable:

assert!(!(3.0..5.0).is_empty());
assert!( (3.0..f32::NAN).is_empty());
assert!( (f32::NAN..5.0).is_empty());

Trait Implementations

impl<N: Clone + Ord + Clone> Clone for Interval<N>

fn clone(&self) -> Interval<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + Ord + Clone> Debug for Interval<N>

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

Formats the value using the given formatter.

impl<N: Ord + Clone> Deref for Interval<N>

Use the Deref operator to get a reference to Range wrapped by the Interval newtype.

type Target = Range<N>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, N: Ord + Clone> Deserialize<'de> for Interval<N>where
    N: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, N: Ord + Clone> From<&'a Range<N>> for Interval<N>

Convert a reference to a Range to an interval by cloning. This conversion will panic if the Range has end < start

fn from(r: &Range<N>) -> Self

Converts to this type from the input type.

impl<N: Ord + Clone> From<Range<N>> for Interval<N>

Convert a Range into an Interval. This conversion will panic if the Range has end < start

fn from(r: Range<N>) -> Self

Converts to this type from the input type.

impl<N: PartialEq + Ord + Clone> PartialEq<Interval<N>> for Interval<N>

fn eq(&self, other: &Interval<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Ord + Clone> Serialize for Interval<N>where
    N: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl<N: Eq + Ord + Clone> Eq for Interval<N>

impl<N: Ord + Clone> StructuralEq for Interval<N>

impl<N: Ord + Clone> StructuralPartialEq for Interval<N>