Types Reference
Complete reference for Railgun's data types and structures.
This page documents all public types exported by Railgun's crates.
Hook Input Types
HookInput
Input received from Claude Code via stdin.
Example:
ToolInput
Parsed tool-specific input.
Configuration Types
Config
Root configuration structure, parsed from railgun.toml.
PolicyConfig
Policy enforcement configuration.
PolicyMode
Enforcement mode.
SecretsConfig
Secret detection configuration.
CommandsConfig
Command pattern blocking configuration.
PathsConfig
Protected paths configuration.
NetworkConfig
Network domain blocking configuration.
ToolsConfig
Tool-level permissions.
Verdict Types
Verdict
Result of policy inspection.
Example:
Block Reason Types
BlockReason
Structured reason for denial.
Policy Engine Types
RuntimePolicy
Compiled policy optimized for fast inspection.
Error Types
PolicyError
Policy configuration or compilation error.
Hook Output Types
HookOutput
Output sent back to Claude Code (via hookSpecificOutput).
Next Steps
- API Overview — Crate overview and usage
- Configuration — Config file format
- Policy Engine — Inspection logic