Struct add_ed::Ed

pub struct Ed<'a, B: Buffer> { /* private fields */ }

The state variable used by the editor to track its internal state

Implementations

impl<'a, B: Buffer> Ed<'a, B>

pub fn new(
    buffer: &'a mut B,
    path: String,
    macros: HashMap<String, String>,
    n: bool,
    l: bool
) -> Result<Self, &'static str>

Construct a new instance of Ed

• An empty file string is recommended if no filepath is opened
• Note that you can initialise the buffer with contents before this, but those contents will be overwritten if a path is given.
• macros behave like scripts given to the ‘g’ command an example is “a\n\n.\n” which appends an empty line

pub fn run_command(
    &mut self,
    ui: &mut dyn UI,
    command: &str
) -> Result<bool, &'static str>

Run the given command

Returns true if the command was to quit

pub fn run_macro(&mut self, ui: &mut dyn UI) -> Result<(), &'static str>

Run given instance of Ed until it receives a command to quit or errors

The returned error type could be improved, suggestions welcome.

pub fn run(&mut self, ui: &mut dyn UI) -> Result<(), &'static str>

pub fn see_state(&self) -> EdState<'_>

Get an immutable reference to part of the editors state