Struct InstallPlan 

pub struct InstallPlan { /* private fields */ }

Everything a backend needs, resolved and validated.

Constructing one is where 05-infrastructure.md item 6 is actually satisfied: the binary path is made absolute and is confirmed to be a file before anything is registered, so a registration that would fail at boot is refused at install time instead.

Implementations

impl InstallPlan

pub fn resolve( identity: ServiceIdentity, request: &InstallRequest, directories: ServiceDirectories, ) -> Result<Self, ServiceError>

Resolves a request against this host.

Errors

ServiceError::BinaryPath when the running executable cannot be located, and ServiceError::BinaryMissing when the path that would be registered is not a file.

pub fn unchecked( identity: ServiceIdentity, start_mode: StartMode, binary: impl Into<PathBuf>, directories: ServiceDirectories, ) -> Self

Builds a plan from values a caller already holds, without touching the filesystem.

This is what makes the renderers testable on a host that has none of the paths involved: a Windows developer can render the systemd unit for /opt/runner-manager/bin/runner-manager and assert every line of it.

pub const fn started_on_demand(self) -> Self

Registers without arming the manager’s automatic start. See InstallRequest::started_on_demand.

pub const fn is_on_demand(&self) -> bool

Whether the manager was asked not to start this by itself.

pub fn with_secret_guard(self, guard: impl Into<PathBuf>) -> Self

Names the file the machine-scoped secret store lives in, for the systemd LoadCredential= line.

InstallPlan::resolve fills this from d2; a test names it directly so that a Windows or macOS CI leg can assert the Linux unit’s credential line for a path that platform does not have.

pub fn secret_guard(&self) -> Option<&Path>

The file the machine-scoped secret store lives in, when one resolved.

pub const fn with_restart(self, restart: RestartPolicy) -> Self

Overrides the restart policy on an already-built plan.

pub fn with_arguments<I, S>(self, arguments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Overrides the registered arguments on an already-built plan.

pub const fn identity(&self) -> &ServiceIdentity

What the operating system calls this registration.

pub const fn start_mode(&self) -> StartMode

Boot or login.

pub fn binary(&self) -> &Path

The resolved absolute path of the binary to register.

pub fn source_binary(&self) -> Option<&Path>

Where Self::binary was copied from, when it is a copy.

None is the legacy layout: the registration names the file a package manager owns, and cannot be upgraded while it runs. See InstallRequest::copied_from.

pub fn arguments(&self) -> &[OsString]

The arguments it is registered with.

pub const fn account(&self) -> &ServiceAccount

The account it runs under.

pub const fn restart(&self) -> RestartPolicy

The restart-on-failure policy.

pub const fn directories(&self) -> &ServiceDirectories

The four directories it was installed against.

pub fn command_line(&self) -> String

The command line as one string, quoted the way each platform expects.

Trait Implementations

impl Clone for InstallPlan

fn clone(&self) -> InstallPlan

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InstallPlan

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

Formats the value using the given formatter.

impl Eq for InstallPlan

impl PartialEq for InstallPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InstallPlan