Struct 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>

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

pub fn write_to(&self, path: impl AsRef<str>) -> Result<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 printed_lines(&self) -> &[(u32, 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) -> u32

The number of bytes in the file.

pub fn len_chars(&self) -> u32

The number of chars in the file.

pub fn len_lines(&self) -> u32

The number of lines in the file.

pub fn text(&self) -> &Text

The Text of the File

pub fn text_mut(&mut self) -> &mut Text

pub fn print_cfg(&self) -> PrintCfg

The mutable Text of the File

pub fn exists(&self) -> bool

Wether o not the File exists or not

Trait Implementations

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

type Cfg = FileCfg

The configuration type

fn cfg() -> Self::Cfg

Returns a WidgetCfg, for use in layout construction

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

Returns the &mut Text that is printed

fn print_cfg(&self) -> PrintCfg

The configuration for how to print Text

fn once()

Actions taken when this widget opens for the first time

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

Prints the widget

fn on_focus(&mut self, area: &U::Area)

Actions to do whenever this Widget is focused.

fn on_unfocus(&mut self, area: &U::Area)

Actions to do whenever this Widget is unfocused.