Struct OperationContext 

pub struct OperationContext { /* private fields */ }

Implementations

impl OperationContext

pub fn context(&self) -> &CallContext

pub fn result(&self) -> &OperationResult

pub fn mod_path(&self) -> &String

pub fn action(&self) -> &Option<String>

pub fn locator(&self) -> &Option<String>

pub fn path(&self) -> &[String]

pub fn metadata(&self) -> &ErrorMetadata

pub fn new() -> Self

pub fn doing<S: Into<String>>(action: S) -> Self

pub fn at<S: Into<String>>(locator: S) -> Self

pub fn with_auto_log(self) -> AutoLogGuard

Arm automatic lifecycle logging by wrapping this context in an AutoLogGuard.

The guard owns the context and, because it is deliberately not Clone, writes the suc! / fail! / cancel! entry exactly once when it is dropped. The context’s result at drop time selects the entry (default: [OperationResult::Fail]).

To attach the same context to an error purely as data, clone through a shared reference (err.with_context(&guard)); that copy never logs.

pub fn with_mod_path<S: Into<String>>(self, path: S) -> Self

pub fn with_doing<S: Into<String>>(&mut self, action: S)

pub fn with_at<S: Into<String>>(&mut self, locator: S)

pub fn set_target<S: Into<String>>(&mut self, target: S)

Alias: set the target resource/operation name. The first call establishes the root target; subsequent calls only append to the path.

pub fn path_string(&self) -> Option<String>

pub fn record_field<K, V>(&mut self, key: K, val: V)

where K: Into<String>, V: Display,

Record a human-readable key-value pair into the context stack.

The entry will appear in the error’s Display output. For typed metadata hidden from console output, use [record_meta()] instead.

Prefer with_field for chained construction. record_field is for when you already have a mutable reference.

pub fn record<K, V>(&mut self, key: K, val: V)

where K: Into<String>, V: Display,

pub fn with_field<K, V>(self, key: K, val: V) -> Self

where K: Into<String>, V: Display,

Builder-pattern version of [record_field].

pub fn record_meta<K, V>(&mut self, key: K, value: V)

where K: Into<String>, V: Into<MetadataValue>,

Record typed metadata that is not included in Display output.

Use this for structured fields intended for serialization, snapshots, or API responses. For user-visible context entries, use [record_field()].

Prefer with_meta for chained construction. record_meta is for when you already have a mutable reference.

pub fn with_meta<K, V>(self, key: K, value: V) -> Self

where K: Into<String>, V: Into<MetadataValue>,

Builder-pattern version of [record_meta].

pub fn mark_suc(&mut self)

pub fn mark_cancel(&mut self)

pub fn mark_fail(&mut self)

pub fn scope(&mut self) -> OperationScope<'_>

Create a scope guard, defaulting to failure state. Requires explicit mark_success(), mark_cancel(), or mark_fail().

pub fn scoped_success(&mut self) -> OperationScope<'_>

Create a scope guard that automatically marks success on drop.

pub fn info<S: AsRef<str>>(&self, message: S)

pub fn debug<S: AsRef<str>>(&self, message: S)

pub fn warn<S: AsRef<str>>(&self, message: S)

pub fn error<S: AsRef<str>>(&self, message: S)

pub fn trace<S: AsRef<str>>(&self, message: S)

pub fn log_info<S: AsRef<str>>(&self, message: S)

Alias for documentation consistency (calls the same-named method above).

pub fn log_debug<S: AsRef<str>>(&self, message: S)

pub fn log_warn<S: AsRef<str>>(&self, message: S)

pub fn log_error<S: AsRef<str>>(&self, message: S)

pub fn log_trace<S: AsRef<str>>(&self, message: S)

Trait Implementations

impl Clone for OperationContext

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 OperationContext

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

Formats the value using the given formatter.

impl Default for OperationContext

fn default() -> Self

Returns the “default value” for a type.

impl Display for OperationContext

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

Formats the value using the given formatter.

impl Eq for OperationContext

impl From<&AutoLogGuard> for OperationContext

Attach an armed AutoLogGuard’s context to an error as pure data.

Taking the guard by shared reference deliberately copies only the data; the guard keeps ownership and remains the single owner responsible for the drop-time log entry. There is intentionally no From<AutoLogGuard> (by value): moving the guard into an error would defer/repeat its log.

fn from(value: &AutoLogGuard) -> Self

Converts to this type from the input type.

impl From<&OperationContext> for OperationContext

fn from(value: &OperationContext) -> Self

Converts to this type from the input type.

impl From<&Path> for OperationContext

fn from(value: &Path) -> Self

Converts to this type from the input type.

impl From<&PathBuf> for OperationContext

fn from(value: &PathBuf) -> Self

Converts to this type from the input type.

impl From<&str> for OperationContext

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<(&str, &str)> for OperationContext

fn from(value: (&str, &str)) -> Self

Converts to this type from the input type.

impl From<(&str, String)> for OperationContext

fn from(value: (&str, String)) -> Self

Converts to this type from the input type.

impl<V> From<(&str, V)> for OperationContext

where V: NotAsRefStr + AsRef<Path>,

fn from(value: (&str, V)) -> Self

Converts to this type from the input type.

impl From<(String, String)> for OperationContext

fn from(value: (String, String)) -> Self

Converts to this type from the input type.

impl From<String> for OperationContext

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for OperationContext

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OperationContext