Enum Error 

pub enum Error {
    NotFound(PathBuf),
    UnsupportedFormat(String),
    UnsupportedNamedRegistry {
        path: PathBuf,
        dep_path: String,
        registry_name: String,
    },
    UnsupportedPnpmLockfileVersion {
        path: PathBuf,
        version: String,
    },
    PnpmLockfileLegacyLayout {
        path: PathBuf,
        version: String,
        marker: String,
    },
    Io(PathBuf, Error),
    Parse(PathBuf, String),
    ResolutionShapeMismatch(PathBuf, String, &'static str),
    ParseDiag(Box<ParseError>),
}

Variants

NotFound(PathBuf)

UnsupportedFormat(String)

UnsupportedNamedRegistry

Fields

path: PathBuf

dep_path: String

registry_name: String

UnsupportedPnpmLockfileVersion

pnpm lockfile formats older than v9 (lockfileVersion 5.x / 6.0, written by pnpm 8.x and earlier) put direct deps in a top-level dependencies: map and key packages as /name@version, with no importers: or snapshots:. Those parse into an empty graph rather than failing, so without this guard an install would link nothing and still exit 0.

Fields

path: PathBuf

version: String

PnpmLockfileLegacyLayout

A lockfile whose declared lockfileVersion is v9 or newer but whose body is pre-v9 (top-level dependencies:, no importers:). Shares the code above: the cause the user has to act on, and the remedy, are the same as a declared pre-v9 version.

Fields

path: PathBuf

version: String

marker: String

Which pre-v9 shape was seen, rendered into the message so the user can see what gave the file away.

Io(PathBuf, Error)

Parse(PathBuf, String)

Structural/serialization lockfile errors that have no source location — shape checks (must be a mapping), version guards (lockfileVersion N unsupported), and yaml_serde::to_string failures during write.

ResolutionShapeMismatch(PathBuf, String, &'static str)

ParseDiag(Box<ParseError>)

Deserialization failure with a byte offset into the source content, so miette’s fancy handler can draw a pointer at the offending byte of the lockfile. Reuses aube_manifest’s ParseError — identical shape, identical rendering — via the same ParseDiag pattern aube-workspace uses.

Implementations

impl Error

pub fn parse(path: &Path, msg: impl Into<String>) -> Self

pub fn parse_json_err(path: &Path, content: String, err: &Error) -> Self

pub fn parse_yaml_err(path: &Path, content: String, err: &Error) -> Self

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Diagnostic for Error

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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.