Enum WorkspacePolicy 

pub enum WorkspacePolicy {
    Ephemeral,
    Persistent {
        root: LocalAbsolutePath,
    },
}

A repository’s configured workspace behaviour.

Persistent carries its root rather than pointing at one, so “persistent without a path” and “ephemeral with a stale path” are both unrepresentable rather than merely rejected — the rule crate::model states for capacity, applied here.

Variants

Ephemeral

D3: attempts are created under the effective host runner root and the whole attempt directory is removed on cleanup.

Persistent

D4/D5: attempts lease a stable sN slot under root and only _work survives cleanup.

Fields

root: LocalAbsolutePath

Implementations

impl WorkspacePolicy

pub fn persistent( root: LocalAbsolutePath, scope: TargetScope, ) -> Result<Self, WorkspaceError>

Configure persistence for a target of scope.

The scope is an argument rather than something the caller checks first, so D7 is stated at the call site rather than remembered. It is not the only gate: Persistent { root } is a public variant and so is constructible directly, which is why ScalePolicy::set_workspace_policy and Self::from_persisted re-run Self::permitted_for on the value they are handed rather than trusting that it came through here.

Errors

WorkspaceError::PersistentRequiresRepositoryScope for an organization target.

pub fn from_persisted( kind: WorkspaceKind, root: Option<LocalAbsolutePath>, scope: TargetScope, ) -> Result<Self, WorkspaceError>

Rebuild a stored workspace policy from its two columns.

Errors

WorkspaceError::PersistentWithoutRoot, WorkspaceError::EphemeralWithRoot, or WorkspaceError::PersistentRequiresRepositoryScope — the three shapes a hand-edited row can claim and this crate cannot have written.

pub const fn kind(&self) -> WorkspaceKind

pub const fn root(&self) -> Option<&LocalAbsolutePath>

The configured root, for a2 to store and d1/e1 to display.

pub const fn is_persistent(&self) -> bool

pub const fn retains_job_workspace(&self) -> bool

Whether the job workspace survives an attempt under this policy.

The counterpart of crate::model::CachePolicy::retains_job_workspace, which is false by construction. That constant is still correct: it answers whether the runner package cache policy retains a workspace, and it never will. This is the deliberate new decision D4 introduced, and it is spelled on a different type for exactly that reason.

Trait Implementations

impl Clone for WorkspacePolicy

fn clone(&self) -> WorkspacePolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspacePolicy

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

Formats the value using the given formatter.

impl Default for WorkspacePolicy

fn default() -> WorkspacePolicy

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkspacePolicy

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WorkspacePolicy

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

Formats the value using the given formatter.

impl Eq for WorkspacePolicy

impl Hash for WorkspacePolicy

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for WorkspacePolicy

fn cmp(&self, other: &WorkspacePolicy) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for WorkspacePolicy

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for WorkspacePolicy

fn partial_cmp(&self, other: &WorkspacePolicy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for WorkspacePolicy

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 WorkspacePolicy