Struct Buffer 

pub struct Buffer {
    pub opts: BufferOpts,
    /* private fields */
}

The widget that is used to print and edit buffers.

Fields

opts: BufferOpts

The PrintOpts of this Buffer

You can use this member to change the way this Buffer will be printed specifically.

Implementations

impl Buffer

pub fn path(&self) -> String

The full path of the buffer.

If there is no set path, returns "*scratch buffer*#{id}".

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

The full path of the buffer.

Returns None if the path has not been set yet, i.e., if the buffer is a scratch buffer.

pub fn path_txt(&self) -> Text

A Text from the full path of this PathKind

Formatting

If the buffer’s path was set:

[buffer]{path}

If the buffer’s path was not set:

[buffer.new.scratch]*scratch buffer #{id}*

pub fn name(&self) -> String

The buffer’s name.

If there is no set path, returns "*scratch buffer #{id}*".

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

The buffer’s name.

Returns None if the path has not been set yet, i.e., if the buffer is a scratch buffer.

pub fn name_txt(&self) -> Text

A Text from the name of this PathKind

The name of a Buffer widget is the same as the path, but it strips away the current directory. If it can’t, it will try to strip away the home directory, replacing it with "~". If that also fails, it will just show the full path.

Formatting

If the buffer’s name was set:

[buffer]{name}

If the buffer’s name was not set:

[buffer.new.scratch]*scratch buffer #{id}*

pub fn path_kind(&self) -> PathKind

The type of PathBuf

This represents the three possible states for a Buffer’s PathBuf, as it could either represent a real Buffer, not exist, or not have been defined yet.

pub fn buffer_id(&self) -> BufferId

A unique identifier for this Buffer.

This is more robust than identifying it by its path or name, or event PathKind, since those could change, but this cannot.

pub fn text(&self) -> &Text

The Text of this Buffer

This is the same as Widget::text, but doesn’t need the Widget trait to be in scope.

pub fn text_mut(&mut self) -> TextMut<'_>

The mutable TextMut of this Buffer

This is the same as Widget::text_mut, but doesn’t need the Widget trait to be in scope.

pub fn len_bytes(&self) -> usize

The number of bytes in the buffer.

pub fn len_chars(&self) -> usize

The number of chars in the buffer.

pub fn len_lines(&self) -> usize

The number of lines in the buffer.

pub fn selections(&self) -> &Selections

The Selections that are used on the Text.

pub fn selections_mut(&mut self) -> &mut Selections

A mutable reference to the Selections.

pub fn exists(&self) -> bool

Whether o not the Buffer exists or not.

Trait Implementations

impl Widget for Buffer

fn update(pa: &mut Pass, handle: &Handle<Self>)

Updates the widget alongside its RwArea in the Handle

fn needs_update(&self, _: &Pass) -> bool

Tells Duat that this Widget should be updated

fn text(&self) -> &Text

The text that this widget prints out

fn text_mut(&mut self) -> TextMut<'_>

A mutable reference to the Text that is printed

fn print_opts(&self) -> PrintOpts

The configuration for how to print Text

fn on_mouse_event(pa: &mut Pass, handle: &Handle<Self>, event: MouseEvent)

How to handle a MouseEvent

fn on_focus(pa: &mut Pass, handle: &Handle<Self>)

where Self: Sized,

Actions to do whenever this Widget is focused

fn on_unfocus(pa: &mut Pass, handle: &Handle<Self>)

where Self: Sized,

Actions to do whenever this Widget is unfocused