Enum PluginError 

#[non_exhaustive]
pub enum PluginError {
    Compile {
        path: PathBuf,
        message: String,
    },
    Runtime {
        id: String,
        message: String,
    },
    ResourceExceeded {
        id: String,
        limit: ResourceLimit,
    },
    Timeout {
        id: String,
    },
    MalformedReturn {
        id: String,
        message: String,
    },
    UnknownDataDep {
        path: PathBuf,
        name: String,
    },
    MalformedDataDeps {
        path: PathBuf,
        message: String,
    },
    IdCollision {
        id: String,
        winner: CollisionWinner,
        loser_path: PathBuf,
    },
}

Every failure mode a plugin can hit at load time or render time. Variants match plugin-api.md §Edge cases; error copy is aimed at the person reading linesmith doctor output, not the plugin author’s script.

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.

Compile

Rhai script failed to parse or compile at load time.

Fields

path: PathBuf

message: String

Runtime

Script runtime error during render(ctx) — any thrown rhai error that wasn’t a resource-limit hit. Drops the segment for this invocation; logged once.

Fields

id: String

message: String

ResourceExceeded

Script exceeded a configured rhai resource limit per plugin-api.md §Resource ceilings. Drops the segment; logged.

Fields

id: String

limit: ResourceLimit

Timeout

Host-side wallclock timer fired before the script returned (default 50ms per render). Distinct from ResourceExceeded { limit: MaxOperations }, which covers CPU-budget overruns surfaced by rhai itself. Drops the segment; logged.

Fields

id: String

MalformedReturn

render(ctx) returned a value that isn’t () and isn’t a map matching the RenderedSegment shape. Drops the segment.

Fields

id: String

message: String

UnknownDataDep

@data_deps declared a name that isn’t in the plugin-accessible set defined by header::KNOWN_DEPS. Per plugin-api.md §@data_deps header syntax, credentials and jsonl are reserved and surface here alongside truly unknown names; consumer-side handling of those reserved names lives in linesmith-core. path rather than id because header parsing fires before const ID has been extracted from the script.

Fields

path: PathBuf

name: String

MalformedDataDeps

@data_deps = ... header didn’t parse as a JSON-style array of bare-string dep names. Same path-over-id rationale as Self::UnknownDataDep.

Fields

path: PathBuf

message: String

IdCollision

Two discovered plugins (or a plugin and a built-in) claim the same id. First-discovered wins per the precedence rules in plugin-api.md §Plugin file location; loser is rejected.

Fields

id: String

winner: CollisionWinner

loser_path: PathBuf

Implementations

impl PluginError

pub fn kind(&self) -> &'static str

Static variant tag — guaranteed token-free &'static str, safe to render in any user-facing diagnostic. Use this in place of Display or Debug when the consumer might be rendering plugin-author-controlled data (e.g., Runtime { message } and MalformedReturn { message } carry strings the script author wrote, which can leak secrets via throw("...")).

Trait Implementations

impl Clone for PluginError

fn clone(&self) -> PluginError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginError

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

Formats the value using the given formatter.

impl Display for PluginError

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

Formats the value using the given formatter.

impl Error for PluginError

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 PartialEq for PluginError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PluginError

impl StructuralPartialEq for PluginError