Struct ReadArgs 

pub struct ReadArgs {
    pub path: String,
    pub offset: Option<usize>,
    pub limit: Option<usize>,
}

Arguments of Read.

Fields

path: String

The file to read.

offset: Option<usize>

The first line to read, from 1.

limit: Option<usize>

How many lines to read.

Implementations

impl ReadArgs

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

Read path from its start.

pub fn lines(self, offset: usize, limit: usize) -> Self

The same read, of at most limit lines from line offset (from 1).

pub fn show(&self, text: &str) -> String

What Read shows of text, the file’s whole text, for this read: its lines from offset (default 1), at most limit of them (default and most MAX_LINES) and MAX_BYTES, as show_lines shows them.

use rig_tools::ReadArgs;

let shown = ReadArgs::new("a.txt").lines(2, 1).show("one\ntwo\nthree\n");
assert_eq!(shown, "two\n[1 more lines; read on with offset 3]\n");

pub fn shown(&self, text: &str) -> (String, LinesShown)

Self::show, and which lines it shows: what Read publishes in its FileRead, for code that shows a file as read would and records what it showed.

use rig_tools::ReadArgs;

let (_, lines) = ReadArgs::new("a.txt").lines(2, 1).shown("one\ntwo\nthree\n");
assert_eq!((lines.first, lines.count, lines.total), (2, 1, 3));

Trait Implementations

impl Clone for ReadArgs

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 ReadArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReadArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ReadArgs

impl JsonSchema for ReadArgs

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ReadArgs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadArgs