Skip to main content

SpriteError

Enum SpriteError 

Source
pub enum SpriteError {
    Config {
        message: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Git {
        operation: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Tmux {
        operation: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Agent {
        message: String,
        agent_id: Option<String>,
    },
    Session {
        message: String,
        session_name: Option<String>,
    },
    FileSystem {
        operation: String,
        path: String,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    Validation {
        message: String,
        field: Option<String>,
        value: Option<String>,
    },
    Process {
        command: String,
        exit_code: Option<i32>,
        stdout: String,
        stderr: String,
    },
    Io {
        operation: String,
        source: Error,
    },
    Yaml {
        message: String,
        line: Option<usize>,
        column: Option<usize>,
    },
    Security {
        message: String,
        violation_type: SecurityViolationType,
    },
    Communication {
        message: String,
        target: Option<String>,
    },
}
Expand description

Main error type for the Sprite application.

Variants§

§

Config

Configuration-related errors

Fields

§message: String
§source: Option<Box<dyn Error + Send + Sync>>
§

Git

Git operation errors

Fields

§operation: String
§source: Option<Box<dyn Error + Send + Sync>>
§

Tmux

Tmux operation errors

Fields

§operation: String
§source: Option<Box<dyn Error + Send + Sync>>
§

Agent

Agent management errors

Fields

§message: String
§agent_id: Option<String>
§

Session

Session management errors

Fields

§message: String
§session_name: Option<String>
§

FileSystem

File system errors

Fields

§operation: String
§path: String
§source: Option<Box<dyn Error + Send + Sync>>
§

Validation

Validation errors

Fields

§message: String
§

Process

Process execution errors

Fields

§command: String
§exit_code: Option<i32>
§stdout: String
§stderr: String
§

Io

I/O errors

Fields

§operation: String
§source: Error
§

Yaml

YAML parsing errors

Fields

§message: String
§column: Option<usize>
§

Security

Security errors

Fields

§message: String
§violation_type: SecurityViolationType
§

Communication

Network/communication errors

Fields

§message: String
§target: Option<String>

Implementations§

Source§

impl SpriteError

Source

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

Create a configuration error with a message.

Source

pub fn config_with_source( message: impl Into<String>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Create a configuration error with a message and source error.

Source

pub fn git(operation: impl Into<String>) -> Self

Create a git operation error.

Source

pub fn git_with_source( operation: impl Into<String>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Create a git operation error with a source error.

Source

pub fn tmux(operation: impl Into<String>) -> Self

Create a tmux operation error.

Source

pub fn tmux_with_source( operation: impl Into<String>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Create a tmux operation error with a source error.

Source

pub fn agent( message: impl Into<String>, agent_id: Option<impl Into<String>>, ) -> Self

Create an agent error.

Source

pub fn session( message: impl Into<String>, session_name: Option<impl Into<String>>, ) -> Self

Create a session error.

Source

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

Create a file system error.

Source

pub fn filesystem_with_source( operation: impl Into<String>, path: impl Into<String>, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Create a file system error with a source error.

Source

pub fn validation( message: impl Into<String>, field: Option<impl Into<String>>, value: Option<impl Into<String>>, ) -> Self

Create a validation error.

Source

pub fn process( command: impl Into<String>, exit_code: Option<i32>, stdout: impl Into<String>, stderr: impl Into<String>, ) -> Self

Create a process execution error.

Source

pub fn io(operation: impl Into<String>, source: Error) -> Self

Create an I/O error.

Source

pub fn yaml( message: impl Into<String>, line: Option<usize>, column: Option<usize>, ) -> Self

Create a YAML parsing error.

Source

pub fn security( message: impl Into<String>, violation_type: SecurityViolationType, ) -> Self

Create a security error.

Source

pub fn communication( message: impl Into<String>, target: Option<impl Into<String>>, ) -> Self

Create a communication error.

Source

pub fn config_not_found(path: impl Into<String>) -> Self

Create a config not found error.

Source

pub fn agent_not_found(agent_id: impl Into<String>) -> Self

Create an agent not found error.

Source

pub fn agent_not_active(agent_id: impl Into<String>) -> Self

Create an agent not active error.

Source

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

Create a session not found error.

Source

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

Create a sync operation error.

Source

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

Create a pane not found error.

Source

pub fn suggestion(&self) -> Option<String>

Get a user-friendly suggestion for resolving this error.

Source

pub fn exit_code(&self) -> i32

Get the exit code for this error type.

Trait Implementations§

Source§

impl Debug for SpriteError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SpriteError

Display implementation that includes suggestions.

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for SpriteError

Implement std::error::Error trait for SpriteError.

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for SpriteError

Convert std::io::Error to our error type.

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for SpriteError

Convert serde_yaml::Error to our error type.

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more