Enum Scope 

#[non_exhaustive]
pub enum Scope {
    Global,
    Local(PathBuf),
}

Install location for a hook.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Global

User-global: writes to the harness’s per-user config dir (e.g., ~/.claude/, ~/.cursor/).

Local(PathBuf)

Project-local: writes to a specific project directory (e.g., ./CLAUDE.md, ./.clinerules).

Implementations

impl Scope

pub fn kind(&self) -> ScopeKind

Returns the ScopeKind discriminant.

pub fn local_root(&self) -> Option<&Path>

Returns the local project root for Scope::Local.

pub fn ensure_contained(&self, path: &Path) -> Result<(), AgentConfigError>

Verify that path is contained within the local project root.

For Scope::Global, rejects symlinks anywhere along the path so a symlinked ~/.claude, ~/.cursor, etc. cannot redirect writes outside the user’s intended config tree. For Scope::Local, rejects symlink components under the project root, canonicalizes the deepest existing path component, then checks it stays within the canonical project root.

Missing tail components are allowed when every existing ancestor stays inside the root and is not a symlink.

Errors

Returns crate::AgentConfigError::PathResolution when:

• any path component is a symlink (Global scope) or a symlink under the local root (Local scope) — "refusing to write through symlink",
• the canonicalized path escapes the local project root — "refusing to write outside scope root",
• an unexpected I/O error occurs while inspecting an existing component.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.