Struct AuditContext 

pub struct AuditContext {
    pub git_commit: Option<String>,
    pub git_branch: Option<String>,
    pub hostname: Option<String>,
    pub working_dir: Option<String>,
    pub ci_pipeline: Option<String>,
    pub ci_job: Option<String>,
    pub metadata: HashMap<String, String>,
}

Context about the environment when the audit event occurred

Fields

git_commit: Option<String>

Git commit hash (if in a git repo)

git_branch: Option<String>

Git branch

hostname: Option<String>

Hostname where the action occurred

working_dir: Option<String>

Working directory

ci_pipeline: Option<String>

CI/CD pipeline identifier

ci_job: Option<String>

CI/CD job identifier

metadata: HashMap<String, String>

Additional context metadata

Implementations

impl AuditContext

pub fn from_environment() -> Self

Create context from current environment

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

Add metadata

Trait Implementations

impl Clone for AuditContext

fn clone(&self) -> AuditContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditContext

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

Formats the value using the given formatter.

impl Default for AuditContext

fn default() -> AuditContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuditContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuditContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.