Skip to main content

HookGateRecord

Struct HookGateRecord 

Source
pub struct HookGateRecord {
    pub v: u32,
    pub ts: DateTime<Utc>,
    pub gate: String,
    pub hook_event: String,
    pub tool: String,
    pub subject: String,
    pub verdict: String,
    pub detail: Option<String>,
    pub session_id: Option<String>,
    pub tool_use_id: Option<String>,
}
Expand description

One structured hook outcome, appended as one JSON line to record_file by kranz hook-guard. Session-writable evidence — parsed tolerantly, never trusted (see module docs).

Fields§

§v: u32

SPEC_VERSION at write time.

§ts: DateTime<Utc>§gate: String

Gate identity (HOOK_GATE_ID).

§hook_event: String

The lifecycle event that fired ("PreToolUse").

§tool: String

The tool whose call was judged (Write, Edit, …).

§subject: String

The judged target: the repo-relative path when it resolved inside the checkout, else the raw path / (unresolved).

§verdict: String

"blocked" (the write was refused in-process) or "error" (the guard itself failed open — the action proceeded and only the engine-side sweep can judge it).

§detail: Option<String>

The guard’s reason / error note.

§session_id: Option<String>

The CLI’s session id from the hook payload, when present.

§tool_use_id: Option<String>

The CLI’s tool-use id from the hook payload, when present.

Implementations§

Source§

impl HookGateRecord

Source

pub fn blocked( spec: &HookGateSpec, hook_event: &str, tool: &str, subject: &str, reason: &str, session_id: Option<&str>, tool_use_id: Option<&str>, ) -> Self

A blocked record for one refused tool call.

Source

pub fn error(spec: &HookGateSpec, note: &str) -> Self

An error record: the guard loaded its spec but could not judge (unparseable hook payload, missing tool name) and failed open.

Source

pub fn append_to(&self, record_file: &Path) -> Result<()>

Append this record as one JSON line to record_file. Best-effort by the caller: an append failure never changes the exit verdict.

Trait Implementations§

Source§

impl Clone for HookGateRecord

Source§

fn clone(&self) -> HookGateRecord

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HookGateRecord

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for HookGateRecord

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for HookGateRecord

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more