Struct Buffer

pub struct Buffer { /* private fields */ }

Internal state for a text buffer backed by a file on disk

Implementations

impl Buffer

pub fn new_from_canonical_file_path(id: usize, path: PathBuf) -> Result<Self>

As the name implies, this method MUST be called with the full cannonical file path

pub fn new_unnamed(id: usize, content: impl Into<String>) -> Self

Create a new unnamed buffer with the given content

pub fn new_virtual( id: usize, name: impl Into<String>, content: impl Into<String>, ) -> Self

Create a new virtual buffer with the given name and content.

The buffer will not be included in the virtual filesystem and it will be removed when it loses focus.

pub fn display_name(&self) -> String

Short name for displaying in the status line

pub fn full_name(&self) -> &str

Absolute path of full name of a virtual buffer

pub fn dir(&self) -> Option<&Path>

The directory containing the file backing this buffer (if any).

pub fn path(&self) -> Option<&Path>

The path for the file backing this buffer (if any).

pub fn output_file_key(&self, cwd: &Path) -> String

The key for the +output buffer that output from command run from this buffer should be redirected to

pub fn is_unnamed(&self) -> bool

Check whether or not this is an unnamed buffer

pub fn contents(&self) -> Vec<u8>

The raw binary contents of this buffer

pub fn str_contents(&self) -> String

The utf-8 string contents of this buffer

pub fn update_ts_state(&mut self, from: usize, n_rows: usize)

pub fn iter_tokenized_lines_from( &self, line: usize, load_exec_range: Option<(bool, Range)>, ) -> LineIter<'_>

pub fn dot_contents(&self) -> String

The contents of the current Dot.

pub fn addr(&self) -> String

The address of the current Dot.

pub fn xdot_contents(&self) -> String

The contents of the current xdot.

This is a virtual dot that is only made use of through the filesystem interface.

pub fn xaddr(&self) -> String

The address of the current xdot.

This is a virtual dot that is only made use of through the filesystem interface.

pub fn len_lines(&self) -> usize

The number of lines currently held in the buffer.

pub fn len_chars(&self) -> usize

The number of utf-8 characters currently held in the buffer.

pub fn is_empty(&self) -> bool

Whether or not the buffer is empty.

Note

This does not always imply that the underlying buffer is zero sized, only that the visible contents are empty.

pub fn line(&self, y: usize) -> Option<Slice<'_>>

The line at the requested index returned as a Slice.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Edit for Buffer

fn insert(&mut self, idx: usize, s: &str)

Insert a string at the specified index

fn remove(&mut self, from: usize, to: usize)

Remove all characters from (from..to)

fn begin_edit_transaction(&mut self)

Mark the start of an edit transaction

fn end_edit_transaction(&mut self)

Mark the end of an edit transaction

fn submatch(&self, m: &Match, n: usize) -> Option<String>

Extract the content of a previous submatch so it can be used in templating