Struct ReadFileOpts 

pub struct ReadFileOpts<'a> {
    pub section: Option<&'a str>,
    pub start_line: Option<usize>,
    pub end_line: Option<usize>,
    pub rows: Option<(usize, usize)>,
    pub max_chars: Option<usize>,
    pub html_transform: bool,
    pub transform: Option<&'a dyn Fn(&str) -> String>,
    pub grep: Option<&'a str>,
    pub grep_context: Option<usize>,
    pub max_matches: Option<usize>,
}

Optional knobs for read_file. Default-constructible.

Fields

section: Option<&'a str>

Extract an HTML element by id attribute (returns the balanced open/close fragment).

start_line: Option<usize>

Slice the file to lines start_line..=end_line (1-indexed).

end_line: Option<usize>

rows: Option<(usize, usize)>

CSV-style row slicing: (start, end) zero-indexed against the data rows (after the header).

max_chars: Option<usize>

Cap the output at this many characters.

html_transform: bool

Apply the built-in HTML → markdown transform via crate::html::html_to_text_impl.

transform: Option<&'a dyn Fn(&str) -> String>

Apply a caller-supplied transform to the raw file content (run before section/grep). Used by the Python wrapper to bridge transform=callable to a Rust closure that re-enters Python.

grep: Option<&'a str>

Filter selected lines to those matching the regex (within the selected line range / section).

grep_context: Option<usize>

Lines of context around each grep match (default 2).

max_matches: Option<usize>

Cap the number of matches returned.

Trait Implementations

impl<'a> Default for ReadFileOpts<'a>

fn default() -> ReadFileOpts<'a>

Returns the “default value” for a type.