Struct Logger 

pub struct Logger { /* private fields */ }

Logger for Ralph output.

Provides consistent, colorized output with optional file logging. All messages include timestamps and appropriate icons.

Implementations

impl Logger

pub const fn new(colors: Colors) -> Self

Create a new Logger with the given colors configuration.

pub fn with_log_file(self, path: &str) -> Self

Configure the logger to also write to a file using direct filesystem access.

Log messages written to the file will have ANSI codes stripped.

Note

For pipeline code where a workspace exists, prefer [with_workspace_log] instead. This method uses std::fs directly and is intended for CLI layer code or legacy compatibility.

pub fn with_workspace_log( self, workspace: Arc<dyn Workspace>, relative_path: &str, ) -> Self

Configure the logger to write logs via a workspace.

This is the preferred method for pipeline code where a workspace exists. Log messages will be written using the workspace abstraction, allowing for testing with MemoryWorkspace.

Arguments

• workspace - The workspace to use for file operations
• relative_path - Path relative to workspace root for the log file

pub fn info(&self, msg: &str)

Log an informational message.

pub fn success(&self, msg: &str)

Log a success message.

pub fn warn(&self, msg: &str)

Log a warning message.

pub fn error(&self, msg: &str)

Log an error message.

pub fn step(&self, msg: &str)

Log a step/action message.

pub fn header(&self, title: &str, color_fn: fn(Colors) -> &'static str)

Print a section header with box drawing.

Arguments

• title - The header title text
• color_fn - Function that returns the color to use

pub fn subheader(&self, title: &str)

Print a sub-header (less prominent than header).

Trait Implementations

impl Default for Logger

fn default() -> Self

Returns the “default value” for a type.

impl Loggable for Logger

fn log(&self, msg: &str)

Write a log message to the sink.

fn info(&self, msg: &str)

Log an informational message.

fn success(&self, msg: &str)

Log a success message.

fn warn(&self, msg: &str)

Log a warning message.

fn error(&self, msg: &str)

Log an error message.

fn header(&self, title: &str, color_fn: fn(Colors) -> &'static str)

Print a section header with box drawing.

impl Printable for Logger

fn is_terminal(&self) -> bool

Check if this printer is connected to a terminal.

impl Write for Logger

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.