Struct noodles_core::region::interval::Interval

pub struct Interval { /* private fields */ }

An interval.

An interval can be closed ([a, b]), left-closed and right-unbounded ([a, ∞)), left-unbounded and right-closed ((-∞, b]), or unbounded ((-∞, ∞)).

Implementations

impl Interval

pub fn start(&self) -> Option<Position>

Returns the start.

Examples

use noodles_core::{region::Interval, Position};

let start = Position::try_from(8)?;
let end = Position::try_from(13)?;
let a = Interval::from(start..=end);
assert_eq!(a.start(), Some(start));

let b = Interval::from(..=end);
assert!(b.start().is_none());

pub fn end(&self) -> Option<Position>

Returns the end.

Examples

use noodles_core::{region::Interval, Position};

let start = Position::try_from(8)?;
let end = Position::try_from(13)?;
let a = Interval::from(start..=end);
assert_eq!(a.end(), Some(end));

let b = Interval::from(start..);
assert!(b.end().is_none());

pub fn contains(&self, position: Position) -> bool

Returns whether the given position is in this interval.

Examples

use noodles_core::{region::Interval, Position};

let interval = Interval::from(Position::try_from(5)?..=Position::try_from(13)?);
assert!(interval.contains(Position::try_from(8)?));
assert!(!interval.contains(Position::try_from(2)?));
assert!(!interval.contains(Position::try_from(21)?));

pub fn intersects(&self, other: Self) -> bool

Returns whether the given interval intersects this interval.

Examples

use noodles_core::{region::Interval, Position};

let a = Interval::from(Position::try_from(5)?..=Position::try_from(13)?);
let b = Interval::from(Position::try_from(8)?..=Position::try_from(21)?);
assert!(a.intersects(b));

let c = Interval::from(Position::try_from(2)?..=Position::try_from(3)?);
assert!(!a.intersects(c));

Trait Implementations

impl Clone for Interval

fn clone(&self) -> Interval

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Interval

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

Formats the value using the given formatter.

impl Display for Interval

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

Formats the value using the given formatter.

impl From<RangeFrom<Position>> for Interval

fn from(range: RangeFrom<Position>) -> Self

Converts to this type from the input type.

impl From<RangeFull> for Interval

fn from(_: RangeFull) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<Position>> for Interval

fn from(range: RangeInclusive<Position>) -> Self

Converts to this type from the input type.

impl From<RangeToInclusive<Position>> for Interval

fn from(range: RangeToInclusive<Position>) -> Self

Converts to this type from the input type.

impl FromStr for Interval

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Interval

fn eq(&self, other: &Interval) -> 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 RangeBounds<Position> for Interval

fn start_bound(&self) -> Bound<&Position>

Start index bound.

fn end_bound(&self) -> Bound<&Position>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

impl Copy for Interval

impl Eq for Interval

impl StructuralPartialEq for Interval