Struct WriteFileGuard

pub struct WriteFileGuard<'a, U: Ui> { /* private fields */ }

Methods from Deref<Target = File>

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

Writes the file to the current Path, 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

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 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 cursors(&self) -> &Cursors

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

pub fn cursors_mut(&mut self) -> Option<&mut Cursors>

A mutable reference to the Cursors, if they exist

pub fn exists(&self) -> bool

Whether o not the File exists or not

Trait Implementations

impl<U: Ui> Deref for WriteFileGuard<'_, U>

type Target = File

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<U: Ui> DerefMut for WriteFileGuard<'_, U>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<U: Ui> Drop for WriteFileGuard<'_, U>

fn drop(&mut self)

Executes the destructor for this type.