Struct CheckLogger

pub struct CheckLogger<'a> { /* private fields */ }

Stateless per-call façade over an explicitly borrowed LoggingOptions value.

A logger with no options is disabled and every method becomes a no-op. This value never reads global configuration and can be created independently for concurrent checks.

Implementations

impl<'a> CheckLogger<'a>

pub const fn new(options: Option<&'a LoggingOptions>) -> Self

Creates a logger from this check’s optional configuration.

pub const fn is_enabled(&self) -> bool

Returns whether this check opted into logging.

pub fn validate(&self) -> Result<(), ArchUnitError>

Validates the explicitly configured sinks without emitting a record.

Built-in architecture checks call this before project discovery. Custom crate::Checkable implementations can do the same when they use this logger directly.

pub fn start_check( &self, rule_name: impl AsRef<str>, ) -> Result<(), ArchUnitError>

Logs the beginning of one named architecture check.

pub fn end_check( &self, rule_name: impl AsRef<str>, violation_count: usize, ) -> Result<(), ArchUnitError>

Logs the completed verdict and its violation count.

pub fn log_progress( &self, message: impl AsRef<str>, ) -> Result<(), ArchUnitError>

Logs detailed execution progress at debug level.

pub fn log_violation( &self, message: impl AsRef<str>, ) -> Result<(), ArchUnitError>

Logs one architecture violation at warning level.

pub fn log_metric( &self, metric_name: impl AsRef<str>, subject: impl AsRef<str>, value: f64, threshold: Option<f64>, ) -> Result<(), ArchUnitError>

Logs one calculated metric value at debug level.

pub fn debug(&self, message: impl AsRef<str>) -> Result<(), ArchUnitError>

Logs an ordinary debug message.

pub fn info(&self, message: impl AsRef<str>) -> Result<(), ArchUnitError>

Logs an ordinary informational message.

pub fn warn(&self, message: impl AsRef<str>) -> Result<(), ArchUnitError>

Logs an ordinary warning.

pub fn error(&self, message: impl AsRef<str>) -> Result<(), ArchUnitError>

Logs an error that prevented a verdict.

Trait Implementations

impl<'a> Clone for CheckLogger<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CheckLogger<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for CheckLogger<'a>