Struct WslProviderRecord

Source

pub struct WslProviderRecord {
    pub schema_version: u32,
    pub distribution: String,
    pub task_name: String,
    pub installed_version: String,
    pub last_verified: DateTime<Utc>,
}

Expand description

One managed WSL distribution, as this workstation last saw it.

Every field is non-secret and every field is checkable against reality.

Fields§

§schema_version: u32

The schema this document was written under.

§distribution: String

The exact distribution name, as wsl --list spells it.

§task_name: String

The Task Scheduler name of the lifecycle task.

§installed_version: String

The runner-manager version last installed inside the distribution.

§last_verified: DateTime<Utc>

When the provider last verified the distribution’s actual state.

Implementations§

Source §

impl WslProviderRecord

Source

pub fn new( distribution: impl Into<String>, task_name: impl Into<String>, installed_version: impl Into<String>, at: DateTime<Utc>, ) -> Self

A record for a distribution this workstation now manages.

Source

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

The directory the records live in.

Source

pub fn path(paths: &AppPaths, distribution: &str) -> Result<PathBuf, WslError>

Where one distribution’s record lives.

The file name is derived the same way the task name is, by the same function — [super::discovery::escaped_name_with_digest] — so two distributions whose names escape alike cannot share a file.

§Errors

WslError::InvalidName for a distribution name that cannot be used.

Source

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

Reads a distribution’s record, if there is one.

§Errors

WslError::InvalidName; WslError::Record when the file exists and cannot be read or parsed; WslError::RecordSchema when it was written by a version this one does not understand.

Source

pub fn read_file(path: &Path) -> Result<Option<Self>, WslError>

Reads one record file.

§Errors

As WslProviderRecord::read.

Source

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

Writes the record, replacing any previous one atomically.

§Atomic, and why it has to be

The document is written to a temporary file in the same directory, flushed to disk, and renamed onto its destination — so a reader either sees the previous record or the new one, never a half-written one. A truncated record is not a cosmetic problem: it is what WslProviderRecord::read would refuse to parse, on a machine whose provisioning had in fact succeeded.

§Errors

WslError::InvalidName and WslError::Record.

Source

pub fn remove(paths: &AppPaths, distribution: &str) -> Result<bool, WslError>

Removes a distribution’s record. Returns whether there was one.

This is the whole of what wsl detach deletes on the Windows side besides the task: nothing inside the distribution, and nothing else in the config directory.

§Errors

WslError::InvalidName and WslError::Record.

Source

pub fn all(paths: &AppPaths) -> Result<Vec<Self>, WslError>

Every record this workstation holds, in file-name order.

A file that does not parse is reported rather than skipped: a config directory with a damaged record is something an operator should be told about, not something wsl list should quietly show one fewer row for.