Struct SourceDiff 

pub struct SourceDiff { /* private fields */ }

A syntax-highlighted diff of two versions of a source file.

Each side is highlighted whole, then split into lines; word-level emphasis goes on top. The language comes from language or the extension of path.

use rich::Console;
use rich_ext::diff::SourceDiff;

let diff = SourceDiff::new("fn a() {}\n", "fn b() {}\n").path("src/lib.rs");
let console = Console::builder().width(40).no_color(true).build();
assert!(console.render_to_string(&diff).contains("+ fn b() {}"));

Implementations

impl SourceDiff

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

Diff two versions of a source text.

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

The language (a name or extension core Syntax knows).

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

The file’s path, for the title, links and (without language) the language.

pub fn paths(self, old: impl Into<String>, new: impl Into<String>) -> Self

Different old and new paths (a rename).

pub fn layout(self, layout: Layout) -> Self

Unified (default) or side by side.

pub fn line_numbers(self, show: bool) -> Self

Show line numbers (default on).

pub fn wrap(self, wrap: bool) -> Self

Wrap long lines (default) or truncate them.

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

Unchanged lines around each change (default 3).

pub fn titles(self, show: bool) -> Self

Show the paths as titles (default on, when a path is set).

pub fn link_template(self, template: impl Into<String>) -> Self

Link line numbers through an editor or web URL template with {path} and {line} (and {column}, always 1), such as vscode://file/{path}:{line}.

pub fn hyperlinker(self, linker: Hyperlinker) -> Self

Link line numbers through a Hyperlinker (file:// URLs by default, relative paths resolved against its base directory).

pub fn view(&self) -> DiffView

The view this diff renders as.

pub fn view_for(&self, console: &Console) -> DiffView

view, highlighting with console’s default code highlighter. Rendering uses this.

Trait Implementations

impl Clone for SourceDiff

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 SourceDiff

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

Formats the value using the given formatter.

impl Renderable for SourceDiff

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. The default assumes the renderable fills the available width (e.g. Panel, Table); Text overrides it with its content width so the top-level print path can shrink to fit. Port of __rich_measure__ / Measurement.get.

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.