Struct ByteSpan 

pub struct ByteSpan {
    pub start: Position,
    pub end: u64,
}

A half-open byte range within a source file, with the start’s line and column.

Spans are retained on every category and value a document holds, which is what lets a write that preserves the original file reproduce untouched values byte for byte instead of re-rendering them.

Fields

start: Position

Where the span begins.

end: u64

Offset one past the last byte of the span.

Implementations

impl ByteSpan

pub const fn new(start: Position, end: u64) -> Self

Creates a span running from start up to but excluding end.

Examples

use molframe_core::{ByteSpan, Position};

let span = ByteSpan::new(Position::new(10, 2, 1), 14);
assert_eq!(span.len(), Some(4));

pub const fn empty(at: Position) -> Self

Creates an empty span at a point.

pub const fn len(self) -> Option<u64>

Returns the length of the span in bytes.

pub const fn is_empty(self) -> bool

Returns true when the span covers no bytes.

pub fn slice(self, source: &[u8]) -> Option<&[u8]>

Returns the bytes this span covers, or None if it runs past the end of source.

Returning None rather than clamping matters: a span that does not fit its buffer means the span and the buffer came from different reads, and silently truncating would hide that.

Trait Implementations

impl Clone for ByteSpan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ByteSpan

impl Debug for ByteSpan

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

Formats the value using the given formatter.

impl Default for ByteSpan

fn default() -> Self

Returns the “default value” for a type.

impl Display for ByteSpan

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

Formats the value using the given formatter.

impl Eq for ByteSpan

impl Hash for ByteSpan

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 ByteSpan

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

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ByteSpan

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ByteSpan

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for ByteSpan