Enum SessionError 

#[non_exhaustive]
pub enum SessionError {
    InvalidState {
        expected: Vec<SessionState>,
        current: SessionState,
    },
    EnvironmentScriptFailed {
        name: String,
        action: String,
        reason: String,
    },
    FormatString {
        context: String,
        reason: String,
    },
    EmbeddedFile {
        name: String,
        source: Error,
    },
    EmbeddedFilePath {
        name: String,
        filename: String,
        reason: String,
    },
    WorkingDirectory {
        path: PathBuf,
        source: Error,
    },
    SubprocessStart {
        command: String,
        source: Error,
    },
    TempDir {
        path: PathBuf,
        source: Error,
    },
    Runtime(String),
    DuplicateEnvironment {
        id: String,
    },
    UnknownEnvironment {
        identifier: String,
    },
    PathPermissions {
        path: String,
        reason: String,
    },
    HelperCommunication(String),
    LifoViolation {
        expected: String,
        got: String,
    },
}

Errors that can occur during session operations.

use openjd_sessions::SessionError;

let err = SessionError::Runtime("something went wrong".into());
assert_eq!(err.to_string(), "something went wrong");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidState

Session is not in the expected state for the requested operation.

Fields

expected: Vec<SessionState>

current: SessionState

EnvironmentScriptFailed

An environment’s onEnter or onExit script failed.

Fields

name: String

action: String

reason: String

FormatString

Failed to resolve a format string expression.

Fields

context: String

reason: String

EmbeddedFile

Failed to write an embedded file.

Fields

name: String

source: Error

EmbeddedFilePath

An embedded file’s filename is not a safe single path component.

Raised when a filename field’s value contains path separators, parent-directory components, null bytes, or is otherwise unsafe. This is a defense-in-depth check; openjd-model also rejects path separators in filenames at template validation time per the 2023-09 spec (§6.1.1 <Filename>).

Fields

name: String

filename: String

reason: String

WorkingDirectory

Failed to create or access the working directory.

Fields

path: PathBuf

source: Error

SubprocessStart

Subprocess failed to start.

Fields

command: String

source: Error

TempDir

Failed to create or manage a temp directory.

Fields

path: PathBuf

source: Error

Runtime(String)

A generic runtime error.

DuplicateEnvironment

Attempted to enter an environment that is already active in this session.

Fields

id: String

UnknownEnvironment

Referenced an environment identifier that does not exist in this session.

Fields

identifier: String

PathPermissions

Failed to set file ownership or permissions (chown/chmod).

Fields

path: String

reason: String

HelperCommunication(String)

Cross-user helper IPC communication failure.

LifoViolation

Attempted to exit an environment out of LIFO order.

Fields

expected: String

got: String

Trait Implementations

impl Debug for SessionError

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

Formats the value using the given formatter.

impl Display for SessionError

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

Formats the value using the given formatter.

impl Error for SessionError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.