Struct InstallRecord 

pub struct InstallRecord {

    pub schema_version: u32,
    pub service_name: String,
    pub manager: String,
    pub start_mode: StartMode,
    pub account: ServiceAccount,
    pub binary: PathBuf,
    pub source_binary: Option<PathBuf>,
    pub arguments: Vec<String>,
    pub restart_delay_secs: u64,
    pub restart_reset_secs: u64,
    pub log_file: PathBuf,
    pub starts_on_demand: bool,
    pub definition_path: Option<PathBuf>,
    pub installed_at: DateTime<Utc>,
    pub installed_by_version: String,
    pub directories: ServiceDirectories,
}

What service install wrote down, and what service status reads back.

This is the record half of 05-infrastructure.md item 6. The service manager also knows the binary path, and the two are compared: a registration whose command line no longer matches the record is a registration something else has edited, and saying so is more useful than picking one of them to believe.

It holds no credential. The nearest thing is the location of the secret store, which d2 publishes for host show to print, and even that is derived rather than stored.

Fields

schema_version: u32

RECORD_SCHEMA_VERSION at the time of writing.

service_name: String

What the operating system calls the registration.

manager: String

Which service manager holds it.

start_mode: StartMode

Boot or login.

account: ServiceAccount

The account it runs under.

binary: PathBuf

The resolved absolute path of the binary at install time. Item 6.

source_binary: Option<PathBuf>

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

#[serde(default)] rather than a schema bump: a record written before this existed is still readable, and reads as None. That is not a silent downgrade — None means the registration names a package manager’s own file, which is the layout that cannot be upgraded while the service runs, and service status says so by name.

arguments: Vec<String>

The arguments it was registered with.

restart_delay_secs: u64

The restart-on-failure delay.

restart_reset_secs: u64

How long it must run before the failure count resets.

log_file: PathBuf

The rotating diagnostic log’s stem. Item 4.

starts_on_demand: bool

Whether the manager was asked not to start this by itself. Always false for a registration an operator made; see InstallRequest::started_on_demand.

#[serde(default)] so that a record missing the field is rejected by the schema check below, with its remedy, rather than by a parse error that names a field an operator has never heard of.

definition_path: Option<PathBuf>

Where the platform’s definition file was written, when there is one.

installed_at: DateTime<Utc>

When the registration was made.

installed_by_version: String

Which build of the product made it.

directories: ServiceDirectories

The four directories the registration was installed against. Item 2’s “configured cache and runtime directories”.

Implementations

impl InstallRecord

pub fn path(paths: &AppPaths) -> PathBuf

Where the record lives, given this host’s directories.

pub fn of( plan: &InstallPlan, definition: &ServiceDefinition, at: DateTime<Utc>, ) -> Self

Builds the record for a plan that has just been applied.

pub fn restart(&self) -> RestartPolicy

The restart policy this record describes, or RestartPolicy::default when the recorded numbers are outside the supported range — which can only happen to a record something else has edited.

pub fn read(paths: &AppPaths) -> Result<Option<Self>, ServiceError>

Reads the record, or reports that there is none.

Ok(None) means no registration was made by this product on this host.

Errors

ServiceError::Record when the file exists and cannot be read, ServiceError::RecordNotPermitted when it exists and this account may not read it, and ServiceError::RecordUnreadable when it is not a record this version understands.

pub fn write(&self, paths: &AppPaths) -> Result<(), ServiceError>

Writes the record, replacing whatever was there.

Errors

ServiceError::Record.

pub fn remove(paths: &AppPaths) -> Result<bool, ServiceError>

Removes the record. Returns whether there was one.

Errors

ServiceError::Record.

Trait Implementations

impl Clone for InstallRecord

fn clone(&self) -> InstallRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstallRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InstallRecord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for InstallRecord

impl PartialEq for InstallRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for InstallRecord

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InstallRecord