Skip to main content

Module package_hooks

Module package_hooks 

Source
Expand description

Public package hooks namespace. Use it for the documented package hooks API surface; prefer crate-root re-exports for common imports. Module items must preserve the core ownership and side-effect boundaries described in this file. Runtime-package records and builders. Use these items to describe the immutable per-run package that freezes provider route, capabilities, policies, sidecars, catalogs, and fingerprints. Builders are data-only and must not perform discovery or execution side effects. This file contains the hooks portion of that contract.

Structs§

ApprovalRequestPatch
Describes the approval request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
CleanupRepairRequest
Describes the cleanup repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
CompactionRequest
Describes the compaction request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ContextInjectionRequest
Describes the context injection request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
DenyReason
Describes the deny reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
DetachValidationRequest
Describes the detach validation request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookCancellationToken
Describes the hook cancellation token portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookConfig
Describes the hook config portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookExecutorRef
Describes the hook executor ref portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookId
Describes the hook id portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookInput
Describes the hook input portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookMutationRights
Describes the hook mutation rights portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookOrdering
Describes the hook ordering portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookQueueConfig
Describes the hook queue config portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookSpec
Describes the hook spec portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookTimeoutPolicy
Describes the hook timeout policy portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
HookView
Describes the hook view portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ProcessRequestPatch
Describes the process request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ProjectionAuditRepairRequest
Describes the projection audit repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ProjectionPatch
Describes the projection patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
RepairNeededReason
Describes the repair needed reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
RetryRequest
Describes the retry request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
StopReason
Describes the stop reason portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
SubagentRequestPatch
Describes the subagent request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ToolRequestPatch
Describes the tool request patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ToolResultPatch
Describes the tool result patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
UsageRollupRepairRequest
Describes the usage rollup repair request portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.
ValidationHintPatch
Describes the validation hint patch portion of a runtime package snapshot. Use it when package authors or tests need explicit package configuration; validation and activation happen in package/runtime coordinators.

Enums§

HookExecutionMode
Enumerates the finite hook execution mode cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookFailurePolicy
Enumerates the finite hook failure policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookMutationRight
Enumerates the finite hook mutation right cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookOrderingPhase
Enumerates the finite hook ordering phase cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookOverflowPolicy
Enumerates the finite hook overflow policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookPoint
Enumerates the finite hook point cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookPrivacyPolicy
Enumerates the finite hook privacy policy cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookResponse
Enumerates the finite hook response cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookResponseClass
Enumerates the finite hook response class cases. Serialized names are part of the SDK contract; update fixtures when variants change.
HookSource
Enumerates the finite hook source cases. Serialized names are part of the SDK contract; update fixtures when variants change.

Constants§

HOOK_SIDECAR_KIND
Constant value for the package::hooks contract. Use it to keep SDK records and tests aligned on the same stable value.
HOOK_SIDECAR_VERSION
Constant value for the package::hooks contract. Use it to keep SDK records and tests aligned on the same stable value.

Functions§

hook_policy_ref
Returns hook policy ref derived from the supplied state. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.
lower_code_hook
Builds the lower code hook value. This is data construction and performs no I/O, journal append, event publication, or process
ordered_hooks_for_point
Returns the ordered hooks for point currently held by this value. This is data-only and does not perform I/O, call host ports, append journals, publish events, or start processes.
validate_hook_specs
Validates the package::hooks invariants and returns a typed error on failure. Validation is pure and does not perform I/O, dispatch, journal appends, or adapter calls.