plume 0.1.1

Spawn a text editor to get text
Documentation
  • Coverage
  • 100%
    2 out of 2 items documented1 out of 1 items with examples
  • Size
  • Source code size: 21.53 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.68 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 23s Average build duration of successful builds.
  • all releases: 23s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Repository
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • bochecha

Plume is a library which can be used in command-line tools to let users write text in their favourite editor.

Think about how Git spawns your ${EDITOR} to let you write a commit message.

Usage

extern crate plume;

use plume::get_text;

let text = get_text()?;

The above will:

  1. find the text editor to use

    • if the ${EDITOR} environment variable is set, then its value is used;
    • otherwise, Plume will search for known text editors like nano or vim;
  2. launch that text editor and capture the text entered by the user;

  3. return that text.

License

Plume is offered under the terms of the GNU Lesser General Public License, either version 3 or any later version.