Skip to content

runtime_paths

Structs

  • RunEntryLayout - Canonical paths within one <runtime>/run/<sandbox_id> entry.
  • RuntimeLayout - Canonical paths rooted at one resolved Firma runtime directory.

firma_runtime_state::runtime_paths::RunEntryLayout

Section titled “firma_runtime_state::runtime_paths::RunEntryLayout”

Struct

Canonical paths within one <runtime>/run/<sandbox_id> entry.

This layout models the files shared between the per-run Sidecar producer and runtime-state observers. Component-private files remain with their owning crates.

Methods:

  • fn from_root<impl Into<PathBuf>>(root: impl Trait) -> Self - Construct a run-entry layout from an already resolved root.
  • fn root(self: &Self) -> &Path - Return the run-entry root.
  • fn into_root(self: Self) -> PathBuf - Consume the layout and return its run-entry root.
  • fn sidecar_socket(self: &Self) -> PathBuf - Return the per-run Sidecar Unix socket path.
  • fn sidecar_config(self: &Self) -> PathBuf - Return the generated per-run Sidecar configuration path.
  • fn sidecar_pid(self: &Self) -> PathBuf - Return the per-run Sidecar PID file path.
  • fn sidecar_metadata(self: &Self) -> PathBuf - Return the per-run Sidecar metadata path.

Traits: Eq

Trait Implementations:

  • PartialEq
    • fn eq(self: &Self, other: &RunEntryLayout) -> bool
  • Clone
    • fn clone(self: &Self) -> RunEntryLayout
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_runtime_state::runtime_paths::RuntimeLayout

Section titled “firma_runtime_state::runtime_paths::RuntimeLayout”

Struct

Canonical paths rooted at one resolved Firma runtime directory.

Construct this value once at a process boundary and pass it to code that reads or publishes runtime files. This prevents separate operations from resolving environment variables differently.

Methods:

  • fn resolve(flag: Option<PathBuf>) -> Result<Self> - Resolve a runtime layout from an optional explicit root and the process
  • fn from_root<impl Into<PathBuf>>(root: impl Trait) -> Self - Construct a layout from an already resolved runtime root.
  • fn root(self: &Self) -> &Path - Return the resolved runtime root.
  • fn into_root(self: Self) -> PathBuf - Consume the layout and return its runtime root.
  • fn capabilities_dir(self: &Self) -> PathBuf - Return <runtime>/capabilities.
  • fn capability_seed(self: &Self, sandbox_id: &SandboxId) -> PathBuf - Return <runtime>/capabilities/<sandbox_id>.toml.
  • fn run_dir(self: &Self) -> PathBuf - Return <runtime>/run.
  • fn run_entry_layout(self: &Self, sandbox_id: &SandboxId) -> RunEntryLayout - Return the canonical layout for <runtime>/run/<sandbox_id>.
  • fn audit_log(self: &Self) -> PathBuf - Return the default shared audit log path.
  • fn sidecar_socket(self: &Self) -> PathBuf - Return the default long-lived sidecar Unix socket path.
  • fn session_state(self: &Self) -> PathBuf - Return the default persistent enforcement session-state path.

Traits: Eq

Trait Implementations:

  • PartialEq
    • fn eq(self: &Self, other: &RuntimeLayout) -> bool
  • Clone
    • fn clone(self: &Self) -> RuntimeLayout
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result