Struct noodles_core::position::Position

pub struct Position(/* private fields */);

A 1-based position.

Implementations

impl Position

pub const MIN: Self = _

The minimum value of a position.

pub const MAX: Self = _

The maximum value of a position.

pub const fn new(n: usize) -> Option<Self>

Creates a position if the given value is not zero.

Examples

use noodles_core::Position;
assert!(Position::new(8).is_some());
assert!(Position::new(0).is_none());

pub const fn get(&self) -> usize

Returns the inner value.

Examples

use noodles_core::Position;
assert_eq!(Position::MIN.get(), 1);

pub const fn checked_add(self, other: usize) -> Option<Self>

Adds an unsigned integer to a 1-based position.

This returns None if the operation overflowed.

Examples

use noodles_core::Position;
let position = Position::try_from(8)?;
assert_eq!(position.checked_add(5), Position::new(13));

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Display for Position

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

Formats the value using the given formatter.

impl From<Position> for usize

fn from(position: Position) -> Self

Converts to this type from the input type.

impl FromStr for Position

type Err = ParseIntError

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 Hash for Position

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 Position

fn cmp(&self, other: &Position) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Position

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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<T> SequenceIndex<T> for Position

type Output = T

The output returned.

fn get(self, sequence: &[T]) -> Option<&Self::Output>

Returns a reference to the output of the given index.

fn get_mut(self, sequence: &mut [T]) -> Option<&mut Self::Output>

Returns a mutable reference to the output of the given index.

fn index(self, sequence: &[T]) -> &Self::Output

Returns a reference to the output of the given index.

fn index_mut(self, sequence: &mut [T]) -> &mut Self::Output

Returns a mutable reference to the output of the given index.

impl TryFrom<usize> for Position

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(n: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position