Struct Report 

#[non_exhaustive]
pub struct Report {
    pub written: Vec<PathBuf>,
    pub unchanged: Vec<PathBuf>,
    pub refused: Vec<RefusedFile>,
    pub stale: Vec<PathBuf>,
    pub missing: Vec<PathBuf>,
    pub changed: Vec<PathBuf>,
    pub table_failures: Vec<TableFailure>,
    pub query_failures: Vec<QueryFailure>,
}

What a generate run did, or would do in a dry run.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

written: Vec<PathBuf>

Files written (in a dry run: files that would be written).

unchanged: Vec<PathBuf>

Files whose contents were already up to date.

refused: Vec<RefusedFile>

Existing files rok-sqlc did not generate and would not overwrite.

stale: Vec<PathBuf>

Stale files: generated files that are no longer part of the plan. Removed after a successful run; a dry run or check only lists them.

missing: Vec<PathBuf>

Check only: planned files that do not exist.

changed: Vec<PathBuf>

Check only: existing planned files whose contents differ from the plan.

table_failures: Vec<TableFailure>

Unsupported tables: skipped when lenient, fatal otherwise.

query_failures: Vec<QueryFailure>

Unsupported queries: skipped when lenient, fatal otherwise.

Implementations

impl Report

pub fn has_drift(&self) -> bool

Whether the run found drift: missing, changed, or stale files.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Report

impl PartialEq for Report

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Report