component

Module: component

Contents

Structs

• ChildPublishedContext - Borrowed child-report inputs available during post-lock plan building.
• ChildPublishedReadiness - Owned child-publication evidence retained after the plan callback returns.
• ComponentName - Opaque identity of a managed process in the local stack.
• ComponentPlanContext - Inputs for producing one complete caller-owned component specification.
• ComponentSpec - Plain description of one component to spawn and wait on for readiness.
• UnixEndpoint - A validated Unix-domain socket filesystem path.

Enums

• ComponentEndpoint - A connectable endpoint exposed by a managed component.
• Readiness - Endpoint evidence required from a component during startup.

---

firma_process_orchestrator::component::ChildPublishedContext

Struct

Borrowed child-report inputs available during post-lock plan building.

Generic Parameters:

• ‘a

Methods:

• fn startup_report_path(self: &Self) -> &'a Path - Return the generation-scoped path for the child’s startup report.
• fn into_readiness(self: Self) -> Readiness - Convert the borrowed planning context into owned readiness evidence.

Trait Implementations:

• Clone
  • fn clone(self: &Self) -> ChildPublishedContext<'a>
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_process_orchestrator::component::ChildPublishedReadiness

Struct

Owned child-publication evidence retained after the plan callback returns.

Traits: Eq

Trait Implementations:

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

firma_process_orchestrator::component::ComponentEndpoint

Enum

A connectable endpoint exposed by a managed component.

TCP endpoints retain their conventional bare host:port representation. On Unix, local sockets use unix:<path>; the prefix makes persisted listen state unambiguous and is shared by display, parsing, and status reporting.

Variants:

• Tcp(std::net::SocketAddr) - An Internet Protocol socket endpoint.
• Unix(UnixEndpoint) - A Unix-domain socket filesystem path.

Traits: Eq

Trait Implementations:

• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
• Deserialize
  • fn deserialize<D>(deserializer: D) -> Result<Self, <D as >::Error>
• PartialEq
  • fn eq(self: &Self, other: &ComponentEndpoint) -> bool
• Serialize
  • fn serialize<S>(self: &Self, serializer: S) -> Result<<S as >::Ok, <S as >::Error>
• FromStr
  • fn from_str(value: &str) -> Result<Self, <Self as >::Err>
• From
  • fn from(addr: SocketAddr) -> Self
• Display
  • fn fmt(self: &Self, formatter: & mut std::fmt::Formatter) -> std::fmt::Result
• Clone
  • fn clone(self: &Self) -> ComponentEndpoint

firma_process_orchestrator::component::ComponentName

Struct

Opaque identity of a managed process in the local stack.

The name determines command selection and runtime-state file names; it does not itself grant authority to signal or collect a process. This machinery is agnostic to which components exist: the concrete names are supplied by the caller at spawn time.

Tuple Struct: ()

Traits: Eq

Trait Implementations:

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

firma_process_orchestrator::component::ComponentPlanContext

Struct

Inputs for producing one complete caller-owned component specification.

The orchestrator invokes the planner once per topology component immediately before spawning it. ready_components contains only earlier components whose endpoints passed readiness and canonical publication.

Generic Parameters:

• ‘a

Methods:

• fn name(self: &Self) -> &'a str - Return the topology identity of the component being planned.
• fn child_published(self: &Self, expected_endpoint: ComponentEndpoint) -> ChildPublishedContext<'a> - Describe child-published readiness for the component being planned.
• fn ready_endpoint(self: &Self, name: &str) -> Option<&'a ComponentEndpoint> - Find a prior validated endpoint by topology identity.

Trait Implementations:

• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_process_orchestrator::component::ComponentSpec

Struct

Plain description of one component to spawn and wait on for readiness.

The caller retains control over all command settings, including non-UTF-8 arguments, environment variables, and the working directory. The orchestrator overrides standard I/O on every platform and native creation flags on Windows. Caller-provided Windows creation flags cannot be preserved through the standard library’s [Command] API.

Fields:

• command: std::process::Command - Fully configured command used to launch this component.
• readiness: Readiness - Contract used to discover and probe this component’s endpoint.

firma_process_orchestrator::component::Readiness

Enum

Endpoint evidence required from a component during startup.

Variants:

• Configured(ComponentEndpoint) - Probe the configured endpoint directly.
• ChildPublished(ChildPublishedReadiness) - Require the child to publish its effective bound endpoint before probing.

Traits: Eq

Trait Implementations:

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

firma_process_orchestrator::component::UnixEndpoint

Struct

A validated Unix-domain socket filesystem path.

Tuple Struct: ()

Methods:

• fn new<impl Into<PathBuf>>(path: impl Trait) -> Result<Self, PathBuf> - Create a Unix endpoint from a UTF-8, single-line filesystem path.
• fn into_path(self: Self) -> Utf8PathBuf - Consume the endpoint and return its validated UTF-8 socket path.

Traits: Eq

Trait Implementations:

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