Struct GeneratedTextFile 

pub struct GeneratedTextFile<'a> {
    path: &'a Path,
    contents: &'a str,
}

Expected UTF-8 text at one generated-file path.

Unlike a byte artifact, invalid UTF-8 is a read error. It is not treated as merely different content.

Fields

path: &'a Path

contents: &'a str

Implementations

impl<'a> GeneratedTextFile<'a>

pub const fn new(path: &'a Path, contents: &'a str) -> Self

Bind expected UTF-8 text to an output path.

pub const fn path(&self) -> &'a Path

Return the output path.

pub fn status(&self) -> Result<Status>

Compare exact UTF-8 text with the current file.

Errors

Returns a contextual error when an existing entry cannot be read as UTF-8 text.

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

Ensure parent directories and atomically replace the text file.

Errors

Returns a contextual error when parent creation or persistence fails.

Trait Implementations

impl<'a> Clone for GeneratedTextFile<'a>

fn clone(&self) -> GeneratedTextFile<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GeneratedTextFile<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for GeneratedTextFile<'a>