Struct BuildStamp

pub struct BuildStamp {
    path: PathBuf,
    stamp: String,
}

Manages a stamp file to track build state. The file is created in the given directory and can have custom content and name.

Fields

path: PathBuf

stamp: String

Implementations

impl BuildStamp

pub fn new(dir: &Path) -> Self

Creates a new BuildStamp for a given directory.

By default, stamp will be an empty file named .stamp within the specified directory.

pub fn path(&self) -> &Path

Returns path of the stamp file.

pub fn stamp(&self) -> &str

Returns the value of the stamp.

Note that this is empty by default and is populated using BuildStamp::add_stamp. It is not read from an actual file, but rather it holds the value that will be used when BuildStamp::write is called.

pub fn add_stamp<S: ToString>(self, stamp: S) -> Self

Adds specified stamp content to the current value.

This method can be used incrementally e.g., add_stamp("x").add_stamp("y").add_stamp("z").

pub fn with_prefix(self, prefix: &str) -> Self

Adds a prefix to stamp’s name.

Prefix cannot start or end with a dot (.).

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

Removes the stamp file if it exists.

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

Creates the stamp file.

pub fn is_up_to_date(&self) -> bool

Checks if the stamp file is up-to-date.

It is considered up-to-date if file content matches with the stamp string.

Trait Implementations

impl Clone for BuildStamp

fn clone(&self) -> BuildStamp

Returns a copy of the value.

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

Performs copy-assignment from source.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes