Struct Editor

pub struct Editor { /* private fields */ }

Keeps track of edits so you can apply them correctly all-at-once with finish

See module documentation for more.

Implementations

impl Editor

pub fn new_with_ast<T: Parse>(source_code: &str) -> Result<(Self, T)>

Parse source_code into the given type, and create a new editor over that source code.

pub fn new(source_code: &str) -> Self

Create a new editor.

Syntax tree types used with this editor must be from the same source.

pub fn replace( &mut self, node: impl Spanned, text: impl Into<String>, ) -> &mut Self

Replace node with text.

let (mut editor, ast) = Editor::new_with_ast::<syn::TraitItemFn>("fn shave_yaks();").unwrap();
assert_eq!(editor.replace(ast.sig.ident, "write_code").finish(), "fn write_code();")

Panics

• may panic if node is from a difference source text than this Editor.
• if there is a conflict (i.e this node, or a parent of it has already been edited).

pub fn prepend( &mut self, node: impl Spanned, text: impl Into<String>, ) -> &mut Self

Put text before node.

let (mut editor, ast) = Editor::new_with_ast::<syn::ExprCast>("ate as u8").unwrap();
assert_eq!(editor.prepend(ast.expr, "i_").finish(), "i_ate as u8")

Panics

• may panic if node is from a difference source text than this Editor.
• if there is a conflict (i.e this node, or a parent of it has already been edited).

pub fn append( &mut self, node: impl Spanned, text: impl Into<String>, ) -> &mut Self

Put text after node.

let (mut editor, ast) = Editor::new_with_ast::<syn::Expr>("maybe").unwrap();
assert_eq!(editor.append(ast, "?").finish(), "maybe?")

Panics

• may panic if node is from a difference source text than this Editor.
• if there is a conflict (i.e this node, or a parent of it has already been edited).

pub fn remove(&mut self, node: impl Spanned) -> &mut Self

Remove the text for node.

let (mut editor, ast) = Editor::new_with_ast::<syn::ExprArray>("[going, going, gone]").unwrap();
assert_eq!(editor.remove(&ast.elems[2]).finish(), "[going, going, ]")

Panics

• may panic if node is from a difference source text than this Editor.
• if there is a conflict (i.e this node, or a parent of it has already been edited).

pub fn source(&self) -> &str

Get a copy of the unedited text.

pub fn source_at(&self, span: impl Spanned) -> &str

Get a copy of the unedited text at the given location.

Panics

• if span is out of bounds.

pub fn finish(&self) -> String

Apply all the edits, returning the final text.

pub fn len(&self) -> usize

Get the number of accumulated edits.

pub fn is_empty(&self) -> bool

See if this editor has accumulated any edits.

pub fn is_empty_at(&self, span: impl Spanned) -> bool

See if this editor has any edits at the given location.

Panics

• if span is out of bounds

Trait Implementations

impl Clone for Editor

fn clone(&self) -> Editor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Editor

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

Formats the value using the given formatter.

impl Ord for Editor

fn cmp(&self, other: &Editor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Editor

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Editor

fn partial_cmp(&self, other: &Editor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Editor

impl StructuralPartialEq for Editor