Struct DocumentLines 

pub struct DocumentLines {
    pub text: String,
    pub lines: Option<LineRange>,
    pub total_lines: u64,
}

A document’s text as a read serves it: whole, or some of its lines (lines=, 0.118.0). The one copy of how a document’s lines are counted and cut, for the server’s reads and the seed runner’s outline alike: a line is what ends at a \n, or the text’s end, numbered from 1 (LineRange::span)

Fields

text: String

The text, or the lines of it asked for

lines: Option<LineRange>

The lines text holds, for a read of some: the range asked for, its end clamped to the last line

total_lines: u64

The whole text’s lines

Implementations

impl DocumentLines

pub fn select( name: &str, text: &str, lines: Option<LineRange>, ) -> Result<Self, DocumentPastEnd>

text whole, or with lines those lines of it. A document has no byte budget: its largest is a few tens of KB, which a read of it whole shows anyway. A range that starts past the last line is refused, naming the document as name

Trait Implementations

impl Clone for DocumentLines

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentLines

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

Formats the value using the given formatter.

impl Eq for DocumentLines

impl PartialEq for DocumentLines

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentLines