Struct Buffer 

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

The widget that is used to print and edit buffers

Fields

opts: PrintOpts

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 save(&mut self) -> Result<Option<usize>, Text>

Writes the buffer to the current PathBuf, if one was set

pub fn save_to(&mut self, path: impl AsRef<Path>) -> Result<Option<usize>>

Writes the buffer to the given Path

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 printed_lines(&self) -> MutexGuard<'_, Vec<(usize, bool)>>

Returns the currently printed set of lines.

These are returned as a usize, showing the index of the line in the buffer, and a bool, which is true when the line is wrapped.

pub fn bytes(&self) -> &Bytes

The Bytes of the Buffer’s Text

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

pub fn add_parser<P: Parser>( &mut self, f: impl FnOnce(BufferTracker) -> P, ) -> Result<(), Text>

Adds a Parser to this Buffer

The Parser will be able to keep track of every single Change that takes place in the Buffer’s Text, and can act on the Buffer accordingly.

This function will fail if a Parser of the same type was already added to this Buffer

pub fn read_parser<P: Parser, Ret>( &self, read: impl FnOnce(&P) -> Ret, ) -> Option<Ret>

Reads from a specific Parser, if it was added

This function will block until the Parser is ready to be read. This usually implies that the Parser is done processing all the Changes up to this point. But it could also be the case that the Parser doesn’t really care about Changes.

While this function is being called, trying to read or write to the same Parser will always return None.

If you want to read in a non blocking way, see Buffer::try_read_parser.

pub fn try_read_parser<P: Parser, Ret>( &self, read: impl FnOnce(&P) -> Ret, ) -> Option<Ret>

Tries tor read from a specific Parser, if it was added

Unlike Buffer::read_parser, this function will only be called when the Parser is ready to be read. This may not be the case if, for example, it is still processing Changes to the Text. In that case, the function will not be called and try_read_parser will return None.

While this function is being called, trying to read or write to the same Parser will always return None.

pub fn write_parser<P: Parser, Ret>( &self, write: impl FnOnce(&mut P) -> Ret, ) -> Option<Ret>

Writes to a specific Parser, if it was added

This function will block until the Parser is ready to be written to. This usually implies that the Parser is done processing all the Changes up to this point. But it could also be the case that the Parser doesn’t really care about Changes.

While this function is being called, trying to read or write to the same Parser will always return None.

If you want to write in a non blocking way, see Buffer::try_write_parser.

pub fn try_write_parser<P: Parser, Ret>( &self, write: impl FnOnce(&mut P) -> Ret, ) -> Option<Ret>

Tries tor read a specific Parser, if it was added

Unlike Buffer::write_parser, this function will only be called when the Parser is ready to be written to. This may not be the case if, for example, it is still processing Changes to the Text. In that case, the function will not be called and try_write_parser will return None.

While this function is being called, trying to read or write to the same Parser will always return None.

Trait Implementations

impl<'a> Parameter<'a> for Buffer

type Returns = Handle

The type that is returned

fn new( pa: &Pass, args: &mut Args<'a>, ) -> Result<(Self::Returns, Option<FormId>), Text>

Tries to consume arguments until forming a parameter

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) -> &mut Text

A mutable reference to the Text that is printed

fn get_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 print(&self, pa: &Pass, painter: Painter, area: &RwArea)

Prints the widget

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