Struct File 

pub struct File {
    pub path: PathBuf,
    pub section: FileSection,
}

Structure representing a file path and its content.

Fields

path: PathBuf

File path.

section: FileSection

File Section.

Implementations

impl File

pub fn from_template( path: impl AsRef<Path>, template: &SectionTemplate, ) -> Result<Self>

Creates a new file from a template.

pub fn new(path: impl AsRef<Path>) -> Self

Creates a new file with the specified path and content.

pub fn save(&self) -> Result<()>

Saves the file.

Methods from Deref<Target = FileSection>

pub fn indented_branch(&mut self, name: impl Into<String>) -> &mut Self

Gets or creates, if it doesn’t exist, an indented branch.

pub fn indexed_write<S: Into<String>>(&mut self, index: usize, content: S)

Writes the content to the file section at the specified index.

pub fn indexed_writeln<S: Into<String>>(&mut self, index: usize, content: S)

Writes the content to the file section at the specified index and adds a new line.

pub fn write<S: Into<String>>(&mut self, content: S)

Writes the content to the file buffer.

pub fn writeln<S: Into<String>>(&mut self, content: S)

Writes the content to the file buffer and adds a new line.

pub fn indent(&mut self) -> &mut Self

Increase the indentation level by 1.

pub fn dedent(&mut self) -> &mut Self

Decrease the indentation level by 1.

pub fn indentation(&mut self, indentation_level: usize) -> &mut Self

Sets the indentation level.

Trait Implementations

impl AsMut<FileSection> for File

fn as_mut(&mut self) -> &mut FileSection

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<FileSection> for File

fn as_ref(&self) -> &FileSection

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<FileSection> for File

fn borrow(&self) -> &FileSection

Immutably borrows from an owned value.

impl BorrowMut<FileSection> for File

fn borrow_mut(&mut self) -> &mut FileSection

Mutably borrows from an owned value.

impl Debug for File

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for File

type Target = FileSection

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for File

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

Mutably dereferences the value.