Skip to main content

Committed

Struct Committed 

Source
pub struct Committed { /* private fields */ }
Expand description

The files a generator writes, and the command that regenerates them.

update writes the files. check compares them with disk.

use layline_codegen::emit::{Committed, Module, generate};

/// Regenerates the artifact.
const COMMAND: &str = "cargo codegen";

fn committed() -> Committed {
    let module = Module::new(vec![]).with_doc(vec![format!("Regenerate with `{COMMAND}`.")]);
    Committed::by(COMMAND).file("src/generated/wire.rs", generate(&module).unwrap().source)
}

fn main() {
    for change in committed().update().expect("write the artifact") {
        println!("{change}");
    }
}

#[test]
fn the_committed_source_is_what_the_emitter_writes() {
    committed().check().expect("the committed artifact is current");
}

Implementations§

Source§

impl Committed

Source

pub fn by(command: impl Into<String>) -> Self

An empty set of files, regenerated by command.

Failures quote command, so it should run from the repository root.

Source

pub fn file(self, path: impl Into<PathBuf>, contents: impl Into<String>) -> Self

Adds a file. A later call for the same path replaces it.

Source

pub fn dir<N, C>( self, dir: impl Into<PathBuf>, files: impl IntoIterator<Item = (N, C)>, ) -> Self
where N: AsRef<Path>, C: Into<String>,

Adds a directory whose .rs files must be exactly files, as (name, contents) pairs.

Other .rs files in dir are reported and deleted. Everything else is left alone.

Source

pub fn update(&self) -> Result<Vec<Change>>

Writes changed files, creating parent directories, and deletes extra ones.

Returns the changes in path order.

§Errors

The first filesystem error.

Source

pub fn check(&self) -> Result<(), Drifted>

Checks the files on disk without changing them.

An unreadable file counts as Drift::Missing.

§Errors

Drifted, listing every mismatched path and the command that fixes it.

Trait Implementations§

Source§

impl Clone for Committed

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Committed

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.