Struct line_span::LineSpan

pub struct LineSpan<'a> { /* fields omitted */ }

LineSpan represents a single line. It is possible to get a &str of the line both including and excluding \n and \r\n.

use line_span::LineSpans;

let text = "foo\nbar\r\nbaz";

for span in text.line_spans() {
    println!(
        "{:>2?}: {:?} {:?}",
        span.range(),
        span.as_str(),
        span.as_str_with_ending(),
    );
}

This will output the following:

0.. 3: "foo" "foo\n"
4.. 7: "bar" "bar\r\n"
9..12: "baz" "baz"

Implementations

impl<'a> LineSpan<'a>

pub fn start(&self) -> usize

Returns the byte index of the start of the line.

pub fn end(&self) -> usize

Returns the byte index of the end of the line, excluding the line ending part \n or \r\n.

To include the line ending part, then use ending.

pub fn ending(&self) -> usize

Returns the byte index of the end of the line, including the line ending part \n or \r\n.

To exclude the line ending part, then use end.

pub fn range(&self) -> Range<usize>

Returns the byte index range of the start and end of the line, excluding the line ending part \n or \r\n.

To include the line ending part, then use range_with_ending.

pub fn range_with_ending(&self) -> Range<usize>

Returns the byte index range of the start and end of the line, including the line ending part \n or \r\n.

To exclude the line ending part, then use range.

pub fn as_str(&self) -> &'a str

Returns &str of the line, excluding \n and \r\n.

To include the line ending part, then use as_str_with_ending.

pub fn as_str_with_ending(&self) -> &'a str

Returns &str of the line, including \n and \r\n.

To exclude the line ending part, then use as_str.

Trait Implementations

impl<'a> Clone for LineSpan<'a>

fn clone(&self) -> LineSpan<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for LineSpan<'a>

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

Renders start, end, and ending of LineSpan and as_str as "line".

impl<'a> Deref for LineSpan<'a>

fn deref(&self) -> &Self::Target

Returns as_str.

type Target = str

The resulting type after dereferencing.

impl<'a> Display for LineSpan<'a>

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

Renders as_str.

impl<'a> From<LineSpan<'a>> for &'a str

fn from(span: LineSpan<'a>) -> &'a str

Returns as_str.

impl<'a> From<LineSpan<'a>> for Range<usize>

fn from(span: LineSpan<'a>) -> Range<usize>

Returns range.

impl<'a> PartialEq<LineSpan<'a>> for LineSpan<'a>

fn eq(&self, other: &LineSpan<'a>) -> bool

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

fn ne(&self, other: &LineSpan<'a>) -> bool

This method tests for !=.

impl<'a> Copy for LineSpan<'a>

impl<'a> Eq for LineSpan<'a>

impl<'a> StructuralEq for LineSpan<'a>

impl<'a> StructuralPartialEq for LineSpan<'a>