Struct duat_core::file::File

pub struct File { /* private fields */ }

The widget that is used to print and edit files.

Implementations

impl File

pub fn write(&self) -> Result<usize, String>

pub fn write_to(&self, path: impl AsRef<str>) -> Result<usize>

pub fn history_mut(&mut self) -> &mut History

pub fn text(&self) -> &Text

impl File

Querying functions

These functions serve the purpose of querying information from the File.

pub fn search(&self) -> Searcher<'_>

pub fn search_at(&self, point: Point) -> Searcher<'_>

pub fn rev_search(&self) -> RevSearcher<'_>

pub fn rev_search_at(&self, point: Point) -> RevSearcher<'_>

pub fn path(&self) -> String

The full path of the file.

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

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

The full path of the file.

Returns None if the path has not been set yet.

pub fn name(&self) -> String

The file’s name.

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

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

The file’s name.

Returns None if the path has not been set yet.

pub fn len_bytes(&self) -> usize

The number of bytes in the file.

pub fn len_chars(&self) -> usize

The number of chars in the file.

pub fn len_lines(&self) -> usize

The number of lines in the file.

pub fn printed_lines(&self) -> &[(usize, bool)]

Returns the currently printed set of lines.

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

impl File

History related functions.

These functions allow for the modification of the File’s Text by navigating through a History’s changes. For now, this is a linear history (i.e. modification removes all future changes), but the plan is to change it to a tree at some point.

pub fn add_moment(&mut self)

Begins a new moment in history.

A new moment makes it so that “undoing” or “redoing” will undo or redo all the changes in the moment. The previous moment can be undone, undoing multiple changes at once.

pub fn redo(&mut self, area: &impl Area, cursors: &mut Cursors)

Redoes the next moment, if there is one.

pub fn undo(&mut self, area: &impl Area, cursors: &mut Cursors)

Undoes the last moment, if there was one.

pub fn mut_text_and_history(&mut self) -> (&mut Text, &mut History)

Returns a mutable reference to the Text and History of the File.

Trait Implementations

impl<U> ActiveWidget<U> for File

where U: Ui,

fn mut_text(&mut self) -> &mut Text

A mutable reference to the Text printed by this cursor.

fn on_focus(&mut self, _area: &<U as Ui>::Area)

Actions to do whenever this [ActionableWidget] is focused.

fn on_unfocus(&mut self, _area: &<U as Ui>::Area)

Actions to do whenever this [ActionableWidget] is unfocused.

impl<U> PassiveWidget<U> for File

where U: Ui,

fn build( _context: Context<U>, _: bool, ) -> (Widget<U>, impl Fn() -> bool, PushSpecs)

where Self: Sized,

fn update(&mut self, _area: &U::Area)

Updates the widget, allowing the modification of its Area.

fn text(&self) -> &Text

The text that this widget prints out.

fn print_cfg(&self) -> &PrintCfg

fn once(_context: Context<U>)

fn print(&mut self, area: &<U as Ui>::Area)

fn name() -> &'static str

where Self: Sized,

impl Send for File

impl Sync for File