Struct FileChange 

pub struct FileChange {
    pub path: String,
    pub kind: ChangeKind,
    pub added: usize,
    pub removed: usize,
    pub hunks: Vec<Hunk>,
    pub before_text: Option<String>,
    pub before: Option<FileState>,
    pub after: Option<FileState>,
}

One file a tool call changed.

Fields

path: String

The file: an absolute path when the tool knows the directory it ran in, as rig-tools’ file tools do, else as the call named it.

kind: ChangeKind

What happened to it.

added: usize

Lines added.

removed: usize

Lines removed.

hunks: Vec<Hunk>

The change as hunks, each line with its ending, with three lines of context; none when the tool did not diff the file (such as one too large to read). unified renders them as a diff.

before_text: Option<String>

The file’s text before the change, when the tool read it whole as UTF-8 within its read limit; None for a created file. after_text is it with the hunks applied.

before: Option<FileState>

The file before the change, when the tool or a checkpoint around it knows it; None for a created file.

after: Option<FileState>

The file the change left, when the tool knows it; None for a deleted file.

Implementations

impl FileChange

pub fn created(path: impl Into<String>, lines: usize) -> Self

path was created with lines lines.

pub fn modified(path: impl Into<String>, added: usize, removed: usize) -> Self

path was changed: added lines added and removed removed.

pub fn deleted(path: impl Into<String>, lines: usize) -> Self

path, which had lines lines, was deleted.

pub fn with_hunks(self, hunks: Vec<Hunk>) -> Self

This change, made by hunks.

pub fn with_before_text(self, text: impl Into<String>) -> Self

This change, made to a file that held text.

pub fn unified(&self) -> String

The change as a unified diff, its hunks under a ---/+++ header naming the path (/dev/null on the side with no file); empty when it has no hunks.

use rig_core::tool::{FileChange, Hunk, HunkLine, Lines};

let change = FileChange::modified("a.rs", 1, 1).with_hunks(vec![Hunk {
    old: Lines { start: 1, count: 2 },
    new: Lines { start: 1, count: 2 },
    lines: vec![
        HunkLine::Same("one\n".into()),
        HunkLine::Removed("two\n".into()),
        HunkLine::Added("2".into()),
    ],
}]);
assert_eq!(
    change.unified(),
    "--- a.rs\n+++ a.rs\n@@ -1,2 +1,2 @@\n one\n-two\n+2\n\\ No newline at end of file\n"
);

pub fn after_text(&self) -> Option<String>

The file’s text after the change: before_text (empty for a created file) with the hunks applied. None for a deleted file, when the text before is not known, or when the hunks do not make the whole change (they do not count the lines added and removed, or do not fit the text before).

use rig_core::tool::{FileChange, Hunk, HunkLine, Lines};

let change = FileChange::modified("a.rs", 1, 1)
    .with_before_text("one\ntwo\n")
    .with_hunks(vec![Hunk {
        old: Lines { start: 2, count: 1 },
        new: Lines { start: 2, count: 1 },
        lines: vec![HunkLine::Removed("two\n".into()), HunkLine::Added("2\n".into())],
    }]);
assert_eq!(change.after_text().as_deref(), Some("one\n2\n"));
assert_eq!(change.changed_lines().collect::<Vec<_>>(), [2]);

pub fn changed_lines(&self) -> impl Iterator<Item = usize> + '_

The lines the change added or rewrote, counted from 1 in the file after it.

pub fn with_before(self, before: FileState) -> Self

This change, made to the file before.

pub fn with_after(self, after: FileState) -> Self

This change, leaving the file after.

Trait Implementations

impl Clone for FileChange

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 FileChange

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileChange

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for FileChange

impl PartialEq for FileChange

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for FileChange

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FileChange