Struct AuditNote 

pub struct AuditNote(/* private fields */);

Handler-side handle on the current request’s audit event.

Extract it next to RequestCtx and describe the operation before the first fallible call, so the description is kept on the error path too:

note.action("group.delete").target("group", &label).detail("force", q.force);

Outside an audited request (GET routes, unit tests) the handle is inert and every call is a no-op. Never put a credential in it.

Implementations

impl AuditNote

pub fn action(&self, action: &'static str) -> &Self

Stable operation name, <resource>.<verb> (e.g. group.delete).

pub fn dry_run(&self, dry_run: bool) -> &Self

Whether the caller asked for a dry run.

pub fn target(&self, kind: &str, value: impl Into<String>) -> &Self

Add one object of kind (group, node, hosts, …) that the operation acts on.

pub fn targets<I, S>(&self, kind: &str, values: I) -> &Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add several objects of kind. No values, no entry.

pub fn nodes<I, S>(&self, values: I) -> &Self

where I: IntoIterator<Item = S>, S: Into<String>,

Record the node xnames the server resolved the targets to.

pub fn produced(&self, kind: &str, id: impl Into<String>) -> &Self

Record the id of something the operation created or started (transition, session, …). Call it only once that happened.

pub fn detail(&self, key: &str, value: impl Serialize) -> &Self

Record a further operation parameter. Silently skipped if it does not serialise.

Trait Implementations

impl Clone for AuditNote

fn clone(&self) -> AuditNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for AuditNote

fn default() -> AuditNote

Returns the “default value” for a type.

impl<S: Send + Sync> FromRequestParts<S> for AuditNote

type Rejection = Infallible

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.