Skip to main content

ModuleSpec

Struct ModuleSpec 

Source
pub struct ModuleSpec {
    pub module_id: String,
    pub program: PathBuf,
    pub args: Vec<String>,
    pub env: Vec<(String, String)>,
    pub reserved: bool,
    pub reserved_prefixes: Vec<String>,
    pub protocol: ModuleProtocol,
    pub overlap: ModuleOverlap,
}
Expand description

How to launch one singleton module process.

Fields§

§module_id: String§program: PathBuf§args: Vec<String>§env: Vec<(String, String)>§reserved: bool

When true this is a reserved module: each spawn gets a fresh one-time launch nonce that the child must echo in its HELLO, so only the daemon-spawned process can register this module_id (a security-boundary module like the credential vault must not be impersonable while it is down/restarting).

§reserved_prefixes: Vec<String>

Module-id prefixes this supervised module owns for reserved HELLO checks. Prefixes come from daemon config and must end in : before they reach the supervisor; the owner module’s current spawn nonce authorizes claims under each prefix.

§protocol: ModuleProtocol

The wire protocol this module speaks, as DECLARED in daemon config.

ModuleProtocol::None changes five things and nothing else: health probing is suppressed, teardown sends SIGTERM before waiting, route.open is refused, the spawn passes NO --subc <path> argument and NO launch nonce, and a clean exit the daemon did not request is restarted as a crash rather than recorded as a stop (see on_child_exit: a stock program exits 0 on a stray SIGTERM, and a stop would leave it down for good). SUBC_MODULE_ID still goes into the environment, because a process ignores an environment variable it does not read.

The argument is the part that cannot be “harmless to a process that ignores it”: a stock binary exits on an unknown flag before it listens (nats-server: “flag provided but not defined: -subc”), which is how the first conformance run against this mode found it. The nonce is withheld because a process that will never present it gains nothing from holding it, and a secret in the environment of a process that does not need it is a leak surface for no benefit.

§overlap: ModuleOverlap

Whether two processes of this module may run at once, which is what a blue/green swap does for the length of its overlap. Declared in daemon config because the daemon must be able to answer it while the module is down, and so a module cannot talk itself into it after registering.

Trait Implementations§

Source§

impl Clone for ModuleSpec

Source§

fn clone(&self) -> Self

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 Debug for ModuleSpec

Source§

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

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

impl Eq for ModuleSpec

Source§

impl PartialEq for ModuleSpec

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ModuleSpec

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<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<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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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