Struct Log 

pub struct Log { /* private fields */ }

One structured log record that can be printed or persisted externally.

Besides the human-readable Log::message, an entry may carry optional structured context for triage — task id, object key, part index, byte offset/length, HTTP status, retry attempt and a sanitized URL. These are set through the with_* builder methods and are most valuable on LogLevel::Error and LogLevel::Key entries. [Log::Display] appends every present field as key=value, so a persisted log line is self-describing.

Implementations

impl Log

pub fn new( level: LogLevel, tag: &'static str, message: impl Into<String>, ) -> Self

Creates a log entry with explicit level and tag (no structured context).

Examples

use rusty_cat::api::{Log, LogLevel};

let log = Log::new(LogLevel::Info, "demo", "hello");
assert_eq!(log.level(), LogLevel::Info);

pub fn trace(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Trace entry (high-frequency; do not persist).

Examples

use rusty_cat::api::Log;

let log = Log::trace("download_chunk", "wrote chunk");
assert_eq!(log.tag(), "download_chunk");

pub fn debug(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Debug entry.

Examples

use rusty_cat::api::Log;

let log = Log::debug("demo", "debug message");
assert_eq!(log.tag(), "demo");

pub fn info(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Info entry.

Examples

use rusty_cat::api::Log;

let log = Log::info("demo", "info message");
assert_eq!(log.tag(), "demo");

pub fn key(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Key entry (key-node checkpoint; persist & forward).

Examples

use rusty_cat::api::Log;

let log = Log::key("enqueue", "task enqueued");
assert_eq!(log.tag(), "enqueue");

pub fn warn(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Warn entry.

Examples

use rusty_cat::api::Log;

let log = Log::warn("cleanup", "abort failed");
assert_eq!(log.tag(), "cleanup");

pub fn error(tag: &'static str, message: impl Into<String>) -> Self

Creates a LogLevel::Error entry (failure; persist with full context).

Examples

use rusty_cat::api::Log;

let log = Log::error("upload_part", "part upload failed").with_part(3);
assert_eq!(log.part_index(), Some(3));

pub fn with_task_id(self, task_id: impl Into<String>) -> Self

Attaches the owning task id.

pub fn with_key(self, key: impl Into<String>) -> Self

Attaches the object / blob key being transferred.

pub fn with_part(self, part_index: u64) -> Self

Attaches the zero-based part / chunk index.

pub fn with_offset(self, offset: u64) -> Self

Attaches the byte offset within the file.

pub fn with_byte_len(self, byte_len: u64) -> Self

Attaches the byte length of the chunk / range.

pub fn with_range(self, offset: u64, byte_len: u64) -> Self

Attaches both the byte offset and the byte length of a range.

pub fn with_http_status(self, status: u16) -> Self

Attaches the HTTP status code associated with a failure.

pub fn with_attempt(self, attempt: u32) -> Self

Attaches the retry attempt number.

pub fn with_max_retries(self, max_retries: u32) -> Self

Attaches the configured maximum number of retry attempts.

pub fn with_error_code(self, code: i32) -> Self

Attaches the SDK error code.

pub fn with_url(self, url: impl AsRef<str>) -> Self

Attaches a URL, automatically passing it through sanitize_url so that SAS tokens, signatures and credentials never reach a persisted log.

pub fn timestamp_ms(&self) -> u64

Returns timestamp in milliseconds.

Examples

use rusty_cat::api::Log;

let log = Log::debug("demo", "message");
let _ts = log.timestamp_ms();

pub fn level(&self) -> LogLevel

Returns log level.

Examples

use rusty_cat::api::{Log, LogLevel};

let log = Log::new(LogLevel::Warn, "demo", "warn");
assert_eq!(log.level(), LogLevel::Warn);

pub fn tag(&self) -> &'static str

Returns static tag.

Examples

use rusty_cat::api::Log;

let log = Log::debug("network", "retry");
assert_eq!(log.tag(), "network");

pub fn message(&self) -> &str

Returns message by shared reference.

Examples

use rusty_cat::api::Log;

let log = Log::debug("demo", "hello");
assert_eq!(log.message(), "hello");

pub fn task_id(&self) -> Option<&str>

Returns the owning task id, if set.

pub fn object_key(&self) -> Option<&str>

Returns the object / blob key, if set.

pub fn part_index(&self) -> Option<u64>

Returns the part / chunk index, if set.

pub fn offset(&self) -> Option<u64>

Returns the byte offset, if set.

pub fn byte_len(&self) -> Option<u64>

Returns the byte length, if set.

pub fn http_status(&self) -> Option<u16>

Returns the HTTP status code, if set.

pub fn attempt(&self) -> Option<u32>

Returns the retry attempt number, if set.

pub fn max_retries(&self) -> Option<u32>

Returns the configured maximum retry attempts, if set.

pub fn error_code(&self) -> Option<i32>

Returns the SDK error code, if set.

pub fn url(&self) -> Option<&str>

Returns the sanitized URL, if set.

pub fn into_message(self) -> String

Consumes the entry and returns owned message.

Examples

use rusty_cat::api::Log;

let log = Log::debug("demo", "hello");
let msg = log.into_message();
assert_eq!(msg, "hello");

Trait Implementations

impl Clone for Log

fn clone(&self) -> Log

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Log

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

Formats the value using the given formatter.

impl Display for Log

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

Formats the value using the given formatter.