pub struct DashboardError {
pub code: String,
pub stage: String,
pub target_id: Option<String>,
pub message: String,
pub retryable: bool,
}Expand description
Error returned by target-side dashboard IPC handlers.
Fields§
§code: StringMachine-readable error code.
stage: StringProcessing stage that produced the error.
target_id: Option<String>Optional target process identifier related to the error.
message: StringHuman-readable diagnostic message.
retryable: boolWhether a caller can retry after the reported condition changes.
Implementations§
Source§impl DashboardError
impl DashboardError
Sourcepub fn new(
code: impl Into<String>,
stage: impl Into<String>,
target_id: Option<String>,
message: impl Into<String>,
retryable: bool,
) -> Self
pub fn new( code: impl Into<String>, stage: impl Into<String>, target_id: Option<String>, message: impl Into<String>, retryable: bool, ) -> Self
Creates a structured dashboard error.
§Arguments
code: Stable machine-readable error code.stage: Processing stage that produced the error.target_id: Optional target process identifier.message: Human-readable diagnostic message.retryable: Whether a retry can later succeed.
§Returns
Returns a DashboardError value ready for JSON serialization.
Sourcepub fn unsupported_method(method: impl AsRef<str>) -> Self
pub fn unsupported_method(method: impl AsRef<str>) -> Self
Creates an unsupported method error.
§Arguments
method: Method name rejected by the parser.
§Returns
Returns a non-retryable DashboardError.
Sourcepub fn validation(
stage: impl Into<String>,
target_id: Option<String>,
message: impl Into<String>,
) -> Self
pub fn validation( stage: impl Into<String>, target_id: Option<String>, message: impl Into<String>, ) -> Self
Creates a validation error.
§Arguments
stage: Validation stage.target_id: Optional target process identifier.message: Human-readable validation message.
§Returns
Returns a non-retryable DashboardError.
Creates a target unavailable error.
§Arguments
stage: Processing stage that tried to use the target.target_id: Target process identifier.message: Human-readable diagnostic message.
§Returns
Returns a retryable DashboardError.
Sourcepub fn ipc_socket_owner_mismatch(message: impl Into<String>) -> Self
pub fn ipc_socket_owner_mismatch(message: impl Into<String>) -> Self
Creates a socket owner mismatch error.
Sourcepub fn peer_cred_uid_mismatch(expected: u32, got: u32) -> Self
pub fn peer_cred_uid_mismatch(expected: u32, got: u32) -> Self
Creates a peer credential uid mismatch error.
Sourcepub fn peer_cred_gid_not_allowed(gid: u32) -> Self
pub fn peer_cred_gid_not_allowed(gid: u32) -> Self
Creates a peer credential gid not allowed error.
Sourcepub fn peer_cred_pid_not_allowed(pid: u32) -> Self
pub fn peer_cred_pid_not_allowed(pid: u32) -> Self
Creates a peer credential pid not allowed error.
Creates a peer credential unavailable error.
Sourcepub fn authz_denied(method: impl Into<String>) -> Self
pub fn authz_denied(method: impl Into<String>) -> Self
Creates an authorization denied error.
Sourcepub fn authz_not_configured() -> Self
pub fn authz_not_configured() -> Self
Creates an authorization not configured error.
Sourcepub fn replay_detected(request_id: impl Into<String>) -> Self
pub fn replay_detected(request_id: impl Into<String>) -> Self
Creates a replay detected error.
Sourcepub fn request_too_large(actual: usize, max_bytes: usize) -> Self
pub fn request_too_large(actual: usize, max_bytes: usize) -> Self
Creates a request too large error.
Sourcepub fn rate_limit_exceeded() -> Self
pub fn rate_limit_exceeded() -> Self
Creates a rate limit exceeded error.
Sourcepub fn audit_write_failed(message: impl Into<String>) -> Self
pub fn audit_write_failed(message: impl Into<String>) -> Self
Creates an audit write failed error.
Sourcepub fn audit_queue_full() -> Self
pub fn audit_queue_full() -> Self
Creates an audit queue full error.
Sourcepub fn allowlist_denied(path: impl Into<String>) -> Self
pub fn allowlist_denied(path: impl Into<String>) -> Self
Creates an allowlist denied error.
Sourcepub fn allowlist_empty() -> Self
pub fn allowlist_empty() -> Self
Creates an allowlist empty error.
Trait Implementations§
Source§impl Clone for DashboardError
impl Clone for DashboardError
Source§fn clone(&self) -> DashboardError
fn clone(&self) -> DashboardError
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DashboardError
impl Debug for DashboardError
Source§impl<'de> Deserialize<'de> for DashboardError
impl<'de> Deserialize<'de> for DashboardError
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl Display for DashboardError
impl Display for DashboardError
Source§impl Error for DashboardError
impl Error for DashboardError
1.30.0 · Source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
1.0.0 · Source§fn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
Source§impl JsonSchema for DashboardError
impl JsonSchema for DashboardError
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl PartialEq for DashboardError
impl PartialEq for DashboardError
Source§fn eq(&self, other: &DashboardError) -> bool
fn eq(&self, other: &DashboardError) -> bool
self and other values to be equal, and is used by ==.Source§impl Serialize for DashboardError
impl Serialize for DashboardError
impl Eq for DashboardError
impl StructuralPartialEq for DashboardError
Auto Trait Implementations§
impl Freeze for DashboardError
impl RefUnwindSafe for DashboardError
impl Send for DashboardError
impl Sync for DashboardError
impl Unpin for DashboardError
impl UnsafeUnpin for DashboardError
impl UnwindSafe for DashboardError
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);