Skip to main content

ModuleId

Enum ModuleId 

Source
pub enum ModuleId {
Show 35 variants ToolsSearch, ToolsApplyPatch, ToolsPersistentShell, ToolsBackground, ToolsWeb, ToolsQuestion, Todos, PlanMode, Subagents, PermissionsApprovals, PermissionsRules, PermissionsSandbox, PermissionsProtectedPaths, Trust, McpClient, McpServer, Hooks, Plugins, Memory, Checkpoint, SessionTree, SessionShare, Reduction, DeferredTools, Cache, ModelCatalog, ModelOauth, Lsp, Formatters, Tui, Server, Notify, StructuredOutput, Telemetry, Integrations,
}
Expand description

The 35 §2 capability modules, numbered exactly as the design’s module table (§2, rows 1-35).

Variants§

§

ToolsSearch

  1. tools.search — glob/content-search/dir-listing tools.
§

ToolsApplyPatch

  1. tools.apply_patch — the apply_patch envelope tool.
§

ToolsPersistentShell

  1. tools.persistent_shell — persistent/interactive shell.
§

ToolsBackground

  1. tools.background — background exec + monitor/event feed.
§

ToolsWeb

  1. tools.web — web fetch + web search.
§

ToolsQuestion

  1. tools.question — structured user-question tool.
§

Todos

  1. todos — plan/task-checklist tool (update_plan).
§

PlanMode

  1. plan_mode — plan enter/exit restriction mode.
§

Subagents

  1. subagents — spawn/named/background sub-agents.
§

PermissionsApprovals

  1. permissions.approvals — approval modes, interactive ask, caching.
§

PermissionsRules

  1. permissions.rules — allow/ask/deny rule language.
§

PermissionsSandbox

  1. permissions.sandbox — OS-level fs/network sandbox.
§

PermissionsProtectedPaths

  1. permissions.protected_paths — never-auto-approved paths.
§

Trust

  1. trust — project/workspace trust gate.
§

McpClient

  1. mcp.client — MCP stdio/remote/OAuth/resources/prompts.
§

McpServer

  1. mcp.server — harness-as-MCP-server.
§

Hooks

  1. hooks — config-registered lifecycle hooks.
§

Plugins

  1. plugins — in-process extension API.
§

Memory

  1. memory — auto memory (agent-maintained, cross-session).
§

Checkpoint

  1. checkpoint — file checkpointing / shadow-git.
§

SessionTree

  1. session.tree — in-place tree, rewind, branch summaries.
§

SessionShare

  1. session.share — public session-sharing links.
§

Reduction

  1. reduction — genuinely-optional lossless reduction policies.
§

DeferredTools

  1. deferred_tools — deferred tool advertising + tool_search.
§

Cache

  1. cache — cache-aware architecture (plans, warnings, TTL).
§

ModelCatalog

  1. model.catalog — aliases, fallback chains, small/utility model.
§

ModelOauth

  1. model.oauth — subscription OAuth login.
§

Lsp

  1. lsp — LSP diagnostics in the edit path + query tool.
§

Formatters

  1. formatters — format-on-write.
§

Tui

  1. tui — full-screen TUI.
§

Server

  1. server — full programmatic RPC/HTTP server.
§

Notify

  1. notify — external notify program / desktop / email.
§

StructuredOutput

  1. structured_output — structured final output.
§

Telemetry

  1. telemetry — OTel/analytics exporters.
§

Integrations

  1. integrations — cloud, IDE/ACP, CI bots, web UI, worktrees.

Implementations§

Source§

impl ModuleId

Source

pub const ALL: &'static [ModuleId]

Every module, in §2 table order (1-35).

Source

pub fn config_key(&self) -> &'static str

The §3.1 config key this module reads (the same strings crate::configfile::MODULE_NAMES/crate::configfile::NESTED_MODULE_NAMES use), for diagnostics. The two schema-collapsed modules (see the module doc comment) report their HOST table’s name, since they have no independent table of their own.

Source

pub fn is_active(&self, hc: &HarnessConfig) -> bool

Whether this module is active in a resolved HarnessConfig — the same module_enabled/module_setting_bool logic the P2 resolver already computes (§3.5 step 7’s “module-activation set”), reused verbatim rather than re-derived, so ModuleActivation can never diverge from crate::configfile::Resolved::modules.

Trait Implementations§

Source§

impl Clone for ModuleId

Source§

fn clone(&self) -> ModuleId

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 Copy for ModuleId

Source§

impl Debug for ModuleId

Source§

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

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

impl Display for ModuleId

Source§

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

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

impl Eq for ModuleId

Source§

impl Hash for ModuleId

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for ModuleId

Source§

fn cmp(&self, other: &ModuleId) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ModuleId

Source§

fn eq(&self, other: &ModuleId) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for ModuleId

Source§

fn partial_cmp(&self, other: &ModuleId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for ModuleId

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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