Struct codespan::ByteIndex

pub struct ByteIndex(pub RawIndex);

A byte position in a source file

Methods

impl ByteIndex

pub fn none() -> ByteIndex

A byte position that will never point to a valid file

pub fn to_usize(self) -> usize

Convert the position into a usize, for use in array indexing

Trait Implementations

impl Clone for ByteIndex

fn clone(&self) -> ByteIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ByteIndex

impl PartialEq for ByteIndex

fn eq(&self, other: &ByteIndex) -> bool

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

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

This method tests for !=.

impl Eq for ByteIndex

impl Hash for ByteIndex

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,

Feeds a slice of this type into the given [Hasher].

impl PartialOrd for ByteIndex

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

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

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

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

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

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

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

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

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

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

impl Ord for ByteIndex

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Default for ByteIndex

fn default() -> ByteIndex

Returns the "default value" for a type.

impl Debug for ByteIndex

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

Formats the value using the given formatter.

impl Display for ByteIndex

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

Formats the value using the given formatter.

impl From<RawIndex> for ByteIndex

fn from(i: RawIndex) -> Self

Performs the conversion.

impl Index for ByteIndex

type Offset = ByteOffset

impl Add<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the + operator.

fn add(self, rhs: ByteOffset) -> ByteIndex

Performs the + operation.

impl AddAssign<ByteOffset> for ByteIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl Sub for ByteIndex

type Output = ByteOffset

The resulting type after applying the - operator.

fn sub(self, rhs: ByteIndex) -> ByteOffset

Performs the - operation.

impl Sub<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

fn sub(self, rhs: ByteOffset) -> ByteIndex

Performs the - operation.

impl SubAssign<ByteOffset> for ByteIndex

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation.