Enum SysprimsError 

pub enum SysprimsError {
    InvalidArgument {
        message: String,
    },
    SpawnFailed {
        source: Error,
    },
    Timeout,
    PermissionDenied {
        pid: u32,
        operation: String,
    },
    NotFound {
        pid: u32,
    },
    NotFoundCommand {
        command: String,
    },
    PermissionDeniedCommand {
        command: String,
    },
    PermissionDeniedPath {
        path: String,
        operation: String,
    },
    NotSupported {
        feature: String,
        platform: String,
    },
    GroupCreationFailed {
        message: String,
    },
    System {
        message: String,
        errno: i32,
    },
    Internal {
        message: String,
    },
}

Canonical error type for all sysprims operations.

This is the single error type used across the sysprims ecosystem. It maps cleanly to FFI error codes and provides structured context for programmatic handling.

FFI Error Code Mapping

Variant	FFI Code
InvalidArgument	SYSPRIMS_ERR_INVALID_ARGUMENT (1)
SpawnFailed	SYSPRIMS_ERR_SPAWN_FAILED (2)
Timeout	SYSPRIMS_ERR_TIMEOUT (3)
PermissionDenied	SYSPRIMS_ERR_PERMISSION_DENIED (4)
NotFound	SYSPRIMS_ERR_NOT_FOUND (5)
NotSupported	SYSPRIMS_ERR_NOT_SUPPORTED (6)
GroupCreationFailed	SYSPRIMS_ERR_GROUP_CREATION_FAILED (7)
System	SYSPRIMS_ERR_SYSTEM (8)
Internal	SYSPRIMS_ERR_INTERNAL (99)

Variants

InvalidArgument

Invalid argument provided.

Returned when input validation fails (e.g., pid = 0, empty command).

Fields

message: String

Description of what was invalid.

SpawnFailed

Failed to spawn a child process.

Wraps the underlying IO error from process creation.

Fields

source: Error

The underlying IO error.

Timeout

Operation timed out.

The child process did not complete within the deadline.

PermissionDenied

Permission denied for the operation.

Typically returned when signaling a process owned by another user.

Fields

pid: u32

The process ID we attempted to operate on.

operation: String

The operation that was denied (e.g., “terminate”, “signal”).

NotFound

Target process not found.

The specified PID does not exist or has already exited.

Fields

pid: u32

The process ID that was not found.

NotFoundCommand

Command not found.

The specified command could not be found in PATH.

Fields

command: String

The command that was not found.

PermissionDeniedCommand

Permission denied for command execution.

The specified command exists but cannot be executed (e.g., not executable).

Fields

command: String

The command that could not be executed.

PermissionDeniedPath

Permission denied for a filesystem path.

Used when opening caller-provided paths such as nohup output targets.

Fields

path: String

The path that could not be accessed.

operation: String

The operation that was denied.

NotSupported

Operation not supported on the current platform.

Some operations are platform-specific (e.g., killpg on Windows).

Fields

feature: String

The feature that is not supported.

platform: String

The platform where it’s not supported.

GroupCreationFailed

Failed to create process group or job object.

On Unix, this means setpgid() failed. On Windows, this means Job Object creation failed.

Fields

message: String

Description of what failed.

System

System-level error with errno/GetLastError context.

Used when a syscall fails with an unexpected error code.

Fields

message: String

Description of the error.

errno: i32

The errno value (Unix) or GetLastError (Windows).

Internal

Internal error (should not happen in normal operation).

Indicates a bug in sysprims or unexpected system state.

Fields

message: String

Description of the internal error.

Implementations

impl SysprimsError

pub fn error_code(&self) -> i32

Get the FFI error code for this error.

Maps to SysprimsErrorCode enum in C-ABI.

impl SysprimsError

pub fn invalid_argument(message: impl Into<String>) -> Self

Create an InvalidArgument error.

pub fn spawn_failed_io(source: Error) -> Self

Create a SpawnFailed error from an IO error.

pub fn permission_denied(pid: u32, operation: impl Into<String>) -> Self

Create a PermissionDenied error.

pub fn not_found(pid: u32) -> Self

Create a NotFound error.

pub fn not_found_command(command: impl Into<String>) -> Self

Create a NotFoundCommand error.

pub fn permission_denied_command(command: impl Into<String>) -> Self

Create a PermissionDeniedCommand error.

pub fn permission_denied_path( path: impl Into<String>, operation: impl Into<String>, ) -> Self

Create a path-oriented permission denied error.

pub fn spawn_failed( command: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a SpawnFailed error with a command and reason.

pub fn not_supported( feature: impl Into<String>, platform: impl Into<String>, ) -> Self

Create a NotSupported error.

pub fn group_creation_failed(message: impl Into<String>) -> Self

Create a GroupCreationFailed error.

pub fn system(message: impl Into<String>, errno: i32) -> Self

Create a System error.

pub fn internal(message: impl Into<String>) -> Self

Create an Internal error.

Trait Implementations

impl Debug for SysprimsError

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

Formats the value using the given formatter.

impl Display for SysprimsError

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

Formats the value using the given formatter.

impl Error for SysprimsError

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.

impl From<Error> for SysprimsError

fn from(source: Error) -> Self

Converts to this type from the input type.