Struct codespan::ByteOffset

source · [−]

pub struct ByteOffset(pub RawOffset);

Expand description

A byte offset in a source file

Tuple Fields

0: RawOffset

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. Read more

impl Add<ByteOffset> for ByteOffset

type Output = ByteOffset

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign<ByteOffset> for ByteIndex

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation. Read more

impl AddAssign<ByteOffset> for ByteOffset

fn add_assign(&mut self, rhs: ByteOffset)

Performs the += operation. Read more

impl Clone for ByteOffset

fn clone(&self) -> ByteOffset

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for ByteOffset

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

Formats the value using the given formatter. Read more

impl Default for ByteOffset

fn default() -> ByteOffset

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for ByteOffset

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

Deserialize this value from the given Serde deserializer. Read more

impl Display for ByteOffset

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

Formats the value using the given formatter. Read more

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. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl Neg for ByteOffset

type Output = ByteOffset

The resulting type after applying the - operator.

fn neg(self) -> ByteOffset

Performs the unary - operation. Read more

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. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

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 ==. Read more

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. Read more

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

impl Serialize for ByteOffset

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

Serialize this value into the given Serde serializer. Read more

impl Sub<ByteOffset> for ByteOffset

type Output = ByteOffset

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl Sub<ByteOffset> for ByteIndex

type Output = ByteIndex

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign<ByteOffset> for ByteOffset

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation. Read more

impl SubAssign<ByteOffset> for ByteIndex

fn sub_assign(&mut self, rhs: ByteOffset)

Performs the -= operation. Read more

impl Copy for ByteOffset

impl Eq for ByteOffset

impl StructuralEq for ByteOffset

impl StructuralPartialEq for ByteOffset

Auto Trait Implementations

impl RefUnwindSafe for ByteOffset

impl Send for ByteOffset

impl Sync for ByteOffset

impl Unpin for ByteOffset

impl UnwindSafe for ByteOffset

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,