Struct File

pub struct File<U: Ui> { /* private fields */ }

The widget that is used to print and edit files

Implementations

impl<U: Ui> File<U>

pub fn write(&mut self) -> Result<Option<usize>, Text>

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

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

Writes the file to the given Path

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 path_kind(&self) -> PathKind

The type of PathBuf

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

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.

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 selections(&self) -> &Selections

The Selections that are used on the Text, if they exist

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

A mutable reference to the Selections, if they exist

pub fn exists(&self) -> bool

Whether o not the File exists or not

pub fn add_reader(&mut self, pa: &mut Pass, cfg: impl ReaderCfg<U>)

Adds a Reader to react to Text Changes

pub fn get_reader<R: Reader<U>>(&self) -> Option<RwData<R>>

Gets a Reader

Trait Implementations

impl<U: Ui> Widget<U> for File<U>

type Cfg = FileCfg

The configuration type

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction

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

Updates the widget, allowing the modification of its RawArea

fn needs_update(&self) -> 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 print_cfg(&self) -> PrintCfg

The configuration for how to print Text

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

Prints the widget

fn once() -> Result<(), Text>

Actions taken when this widget opens for the first time

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

where Self: Sized,

Actions to do whenever this Widget is focused

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

where Self: Sized,

Actions to do whenever this Widget is unfocused