Struct LifecycleHookEngine 

pub struct LifecycleHookEngine { /* private fields */ }

Implementations

impl LifecycleHookEngine

pub fn new_with_session_gated( workspace: PathBuf, config: &HooksConfig, trigger: SessionStartTrigger, session_id: impl Into<String>, workspace_gated: bool, ) -> Result<Option<Self>>

Construct the engine with the workspace approval gate.

When workspace_gated is true, the workspace configuration (a workspace-root vtcode.toml, the workspace .vtcode/ fallback, a project profile, or a workspace-sourced agent spec with hooks) contains lifecycle hook commands. No lifecycle command then executes until the user explicitly approves the exact command set this engine will run, bound to its digest. Callers must pass true whenever VTCodeConfig.workspace_lifecycle_hooks is non-empty or the active primary agent contributes workspace-controlled hooks.

pub async fn run_session_start(&self) -> Result<SessionStartHookOutcome>

pub async fn run_session_end( &self, turn_id: &str, reason: SessionEndReason, ) -> Result<Vec<HookMessage>>

pub async fn run_subagent_start( &self, parent_session_id: &str, child_thread_id: &str, agent_name: &str, display_label: &str, background: bool, status: &str, transcript_path: Option<&Path>, ) -> Result<Vec<HookMessage>>

pub async fn run_subagent_stop( &self, parent_session_id: &str, child_thread_id: &str, agent_name: &str, display_label: &str, background: bool, status: &str, transcript_path: Option<&Path>, ) -> Result<Vec<HookMessage>>

pub async fn run_user_prompt_submit( &self, turn_id: &str, prompt: &str, ) -> Result<UserPromptHookOutcome>

Execute all UserPromptSubmit hooks that match the prompt content.

pub async fn run_permission_request( &self, tool_name: &str, tool_input: Option<&Value>, permission_request: &PermissionRequest, permission_suggestions: &[Value], ) -> Result<PermissionRequestHookOutcome>

Execute all PermissionRequest hooks that match the tool name.

pub async fn run_pre_tool_use( &self, tool_name: &str, tool_input: Option<&Value>, tool_call_id: Option<&str>, ) -> Result<PreToolHookOutcome>

Execute all PreToolUse hooks that match the tool name.

Hooks run in configuration order. When a hook returns hookSpecificOutput.updatedInput, later hooks receive the rewritten tool input in their payload, so policy hooks placed after rewrite hooks observe the final command. The first Allow/Deny decision still short-circuits the remaining hooks.

pub async fn run_post_tool_use( &self, tool_name: &str, tool_input: Option<&Value>, tool_output: &Value, tool_call_id: Option<&str>, ) -> Result<PostToolHookOutcome>

Execute all PostToolUse hooks that match the tool name.

pub async fn run_pre_compact( &self, trigger: CompactionTrigger, mode: CompactionMode, original_message_count: usize, compacted_message_count: usize, history_artifact_path: Option<&str>, ) -> Result<PreCompactHookOutcome>

Execute all PreCompact hooks that match the compaction trigger.

pub async fn run_notification( &self, notification_type: NotificationHookType, title: &str, message: &str, ) -> Result<Vec<HookMessage>>

Execute all Notification hooks that match the notification type.

pub async fn run_stop( &self, last_assistant_message: &str, stop_hook_active: bool, ) -> Result<StopHookOutcome>

Execute all Stop hooks.

pub async fn update_transcript_path(&self, path: Option<PathBuf>)

Update the transcript path that hooks can access via the VT_TRANSCRIPT_PATH env var.

pub async fn transcript_path(&self) -> Option<PathBuf>

Return the current transcript path, if set.

pub fn workspace_gated(&self) -> bool

Whether the workspace approval gate is active for this engine.

pub fn command_digest(&self) -> &str

Digest of the exact lifecycle command set this engine will execute. Approvals are bound to this digest and revalidated before every spawn.

pub fn command_previews(&self) -> Vec<LifecycleHookCommandPreview>

Every lifecycle command this engine will execute, with its canonical event key — the exact set an approval covers.

pub async fn approve_workspace_hooks(&self)

Mark this engine’s exact command set as approved for the session. Only a digest equal to command_digest() satisfies the gate.

pub async fn workspace_hooks_need_approval(&self) -> bool

Whether the gate is active and the current command set is not yet approved. The binary prompts the user before the first lifecycle run when this is true.

Trait Implementations

impl Clone for LifecycleHookEngine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.