Struct ReadTextFileOptions 

pub struct ReadTextFileOptions {
    pub path: String,
    pub encoding: Option<String>,
    pub start_line: Option<usize>,
    pub end_line: Option<usize>,
    pub cancellation: CancellationToken,
}

Options for reading a text file.

Fields

path: String

Path inside the sandbox.

encoding: Option<String>

Text encoding (utf-8 when absent).

start_line: Option<usize>

1-based inclusive first line.

end_line: Option<usize>

1-based inclusive last line; past the end reads through EOF.

cancellation: CancellationToken

Cancels the read.

Implementations

impl ReadTextFileOptions

pub fn new(path: impl Into<String>) -> Self

Reads all of path.

pub fn lines(self, start_line: usize, end_line: usize) -> Self

Restricts to a line range.

Trait Implementations

impl Clone for ReadTextFileOptions

fn clone(&self) -> ReadTextFileOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadTextFileOptions

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

Formats the value using the given formatter.