Struct codespan::ByteOffset

pub struct ByteOffset(pub RawOffset);

A byte offset in a source file

Implementations

impl ByteOffset

pub fn from_char_len(ch: char) -> ByteOffset

Create a byte offset from a UTF8-encoded character

use codespan::ByteOffset;

assert_eq!(ByteOffset::from_char_len('A').to_usize(), 1);
assert_eq!(ByteOffset::from_char_len('ß').to_usize(), 2);
assert_eq!(ByteOffset::from_char_len('ℝ').to_usize(), 3);
assert_eq!(ByteOffset::from_char_len('💣').to_usize(), 4);

pub fn from_str_len(value: &str) -> ByteOffset

Create a byte offset from a UTF- encoded string

use codespan::ByteOffset;

assert_eq!(ByteOffset::from_str_len("A").to_usize(), 1);
assert_eq!(ByteOffset::from_str_len("ß").to_usize(), 2);
assert_eq!(ByteOffset::from_str_len("ℝ").to_usize(), 3);
assert_eq!(ByteOffset::from_str_len("💣").to_usize(), 4);

pub const fn to_usize(self) -> usize

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

Trait Implementations

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 Add<ByteOffset> for ByteOffset

type Output = ByteOffset

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<ByteOffset> for ByteIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl AddAssign<ByteOffset> for ByteOffset

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation.

impl Clone for ByteOffset

fn clone(&self) -> ByteOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ByteOffset

impl Debug for ByteOffset

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

Formats the value using the given formatter.

impl Default for ByteOffset

fn default() -> ByteOffset

Returns the "default value" for a type.

impl Display for ByteOffset

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

Formats the value using the given formatter.

impl Eq for ByteOffset

impl From<ByteOffset> for RawOffset

fn from(offset: ByteOffset) -> RawOffset

Performs the conversion.

impl From<ByteOffset> for usize

fn from(offset: ByteOffset) -> usize

Performs the conversion.

impl From<i64> for ByteOffset

fn from(i: RawOffset) -> Self

Performs the conversion.

impl Hash for ByteOffset

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 Neg for ByteOffset

type Output = ByteOffset

The resulting type after applying the - operator.

fn neg(self) -> ByteOffset

Performs the unary - operation.

impl Offset for ByteOffset

const ZERO: ByteOffset

impl Ord for ByteOffset

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ByteOffset> for ByteOffset

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

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

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

This method tests for !=.

impl PartialOrd<ByteOffset> for ByteOffset

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for ByteOffset

impl StructuralPartialEq for ByteOffset

impl Sub<ByteOffset> for ByteOffset

type Output = ByteOffset

The resulting type after applying the - operator.

fn sub(self, rhs: ByteOffset) -> 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 ByteOffset

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation.

impl SubAssign<ByteOffset> for ByteIndex

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation.