Struct lark_span::Span

pub struct Span<File: SpanFile> { /* fields omitted */ }

Methods

impl<File: SpanFile> Span<File>

pub fn new(
    file: File,
    start: impl Into<ByteIndex>,
    end: impl Into<ByteIndex>
) -> Self

pub fn initial(file: File) -> Self

Gives an empty span at the start of file.

pub fn eof(file: File, text: &Text) -> Self

Gives the "EOF" span for a file with the given text. This is an empty span pointing at the end.

pub fn extended_until_end_of(self, other_span: Span<File>) -> Span<File>

Returns a span beginning at the start of this span but ending at the end of other_span (which must be within the same file).

pub fn file(&self) -> File

pub fn start(&self) -> ByteIndex

pub fn end(&self) -> ByteIndex

pub fn in_file<NewFile: SpanFile>(self, file: NewFile) -> Span<NewFile>

pub fn in_file_named(self, file: FileName) -> Span<FileName>

pub fn contains(self, span: Span<File>) -> bool

pub fn contains_index(self, index: ByteIndex) -> bool

pub fn len(&self) -> ByteSize

pub fn relative_to_entity(self, entity_span: Span<File>) -> Span<CurrentEntity>

Trait Implementations

impl<File: Eq + SpanFile> Eq for Span<File>

impl<File: Clone + SpanFile> Clone for Span<File>

fn clone(&self) -> Span<File>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<File: Copy + SpanFile> Copy for Span<File>

impl<File: PartialOrd + SpanFile> PartialOrd<Span<File>> for Span<File>

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

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

fn lt(&self, other: &Span<File>) -> bool

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

fn le(&self, other: &Span<File>) -> bool

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

fn gt(&self, other: &Span<File>) -> bool

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

fn ge(&self, other: &Span<File>) -> bool

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

impl<File: PartialEq + SpanFile> PartialEq<Span<File>> for Span<File>

fn eq(&self, other: &Span<File>) -> bool

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

fn ne(&self, other: &Span<File>) -> bool

This method tests for !=.

impl<File: Ord + SpanFile> Ord for Span<File>

fn cmp(&self, other: &Span<File>) -> 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<File: Hash + SpanFile> Hash for Span<File>

fn hash<__HFile: Hasher>(&self, state: &mut __HFile)

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<File: SpanFile> Index<Span<File>> for Text

type Output = str

The returned type after indexing.

fn index(&self, span: Span<File>) -> &str

Performs the indexing (container[index]) operation.

impl<File: SpanFile> Index<Span<File>> for str

type Output = str

The returned type after indexing.

fn index(&self, range: Span<File>) -> &str

Performs the indexing (container[index]) operation.

impl<File: Debug + SpanFile> Debug for Span<File>

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

Formats the value using the given formatter.

impl<File: SpanFile + DebugWith> DebugWith for Span<File>

fn fmt_with<Cx: ?Sized>(&self, cx: &Cx, fmt: &mut Formatter) -> Result

fn debug_with<Cx>(&'me self, cx: &'me Cx) -> DebugCxPair<'me, &'me Self, Cx> where
    Cx: ?Sized, 

fn into_debug_with<Cx>(self, cx: &'me Cx) -> DebugCxPair<'me, Self, Cx> where
    Cx: ?Sized, 

impl<F: SpanFile> ReportingSpan for Span<F>

fn with_start(&self, start: usize) -> Self

fn with_end(&self, end: usize) -> Self

fn start(&self) -> usize

fn end(&self) -> usize