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, config: Arc<RwLock<Config>>, ) -> Result<Self>

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

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

Create a new unnamed buffer with the given content

pub fn new_virtual( id: usize, name: impl Into<String>, content: impl Into<String>, config: Arc<RwLock<Config>>, ) -> 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 has_trailing_newline(&self) -> bool

Whether or not the contents of the buffer end with a final newline character.

POSIX semantics define a line as “A sequence of zero or more non-newline characters plus a terminating newline character.”

See: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206

pub fn configured_filetype(&self) -> Option<String>

Check the current Config to see if this buffer matches a known filetype configuration.

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 clear(&mut self)

Fully clear the contents of this buffer, notifying fsys of the change

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

The line at the requested index returned as a Slice.

pub fn handle_action( &mut self, a: Action, source: Source, ) -> Option<ActionOutcome>

The error result of this function is an error string that should be displayed to the user

pub fn set_dot_from_cursor(&mut self, idx: usize)

Set this Buffer’s dot to an explicit cursor position, clamping to EOB.

pub fn set_dot_from_range(&mut self, from: usize, to: usize)

Set this Buffer’s dot to an explicit Range, clamping to EOB.

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

impl Haystack<Regex> for Buffer

fn is_match_between(&self, re: &Regex, from: usize, to: usize) -> bool

Returns true if there is a match for the regex between the given byte offsets in the haystack.

fn captures_between( &self, re: &Regex, from: usize, to: usize, ) -> Option<RawCaptures>

Searches for the first match of this regex between the given byte offsets in the given haystack, returning the overall match along with the matches of each capture group in the regex. If no match is found, then None is returned.

impl Haystack for Buffer

fn try_make_contiguous(&mut self)

fn is_contiguous(&self) -> bool

fn len(&self) -> usize

fn substr_from<'a>(&'a self, offset: usize) -> Option<Cow<'a, str>>

fn substr<'a>(&'a self, from: usize, to: usize) -> Cow<'a, str>

fn byte_to_char(&self, byte_idx: usize) -> Option<usize>

fn char_to_byte(&self, char_idx: usize) -> Option<usize>

fn iter_from(&self, from: usize) -> Option<impl Iterator<Item = (usize, char)>>

fn iter_between( &self, from: usize, to: usize, ) -> impl Iterator<Item = (usize, char)>

fn rev_iter_between( &self, from: usize, to: usize, ) -> impl Iterator<Item = (usize, char)>

impl Sliceable for Buffer

type Slice<'h> = Slice<'h> where Self: 'h

The output of the slice method.

fn char_at(&self, byte_offset: usize) -> Option<char>

Returns the character at the given byte offset if one exists, otherwise None.

fn slice(&self, range: Range<usize>) -> Self::Slice<'_>

The contiguous sub-section of self that is denoted by the given byte Range.

fn max_len(&self) -> usize

The maximum length in bytes.

impl Writable for Buffer

fn write_to<W>(&self, w: &mut W) -> Result<usize>

where W: Write,

Writes self to the given io::Write, returning the number of bytes written.