Enum Lockfile 

#[non_exhaustive]
pub enum Lockfile {
    V9 {
        importers: HashMap<String, Importer>,
        snapshots: HashMap<String, Snapshot>,
    },
}

A subset of the pnpm-lock.yaml file format.

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.

V9

Only supports version 9.0 currently, though apparently versions are backwards compatible? https://github.com/orgs/pnpm/discussions/6857

Fields

importers: HashMap<String, Importer>

Importers describe the packages in the workspace and their resolved dependencies.

The key is a relative path to the directory containing the package.json, e.g.: “packages/foo”, or “.” for the workspace root.

snapshots: HashMap<String, Snapshot>

Snapshots describe the packages in the store (e.g. from the registry) and their resolved dependencies.

The key is the package name and qualified version, e.g.: “foo@1.2.3”, “bar@4.5.6(peer@7.8.9)”, and so on (pnpm code refers to this as the “depPath”).

Note that this key also currently serves as the directory entry in the virtual store, e.g. “node_modules/.pnpm/{key}”, see: https://pnpm.io/how-peers-are-resolved

Implementations

impl Lockfile

pub fn read_from_workspace_dir(workspace_dir: &Path) -> Result<Self>

Read the content of a pnpm-lock.yaml file.

Errors

• Error::ReadLockfile, if the pnpm-lock.yaml file cannot be read from the provided workspace directory.
• Error::ParseLockfile, if the data cannot be parsed as a Lockfile.

pub fn from_slice(data: &[u8]) -> Result<Self>

Parse the content of a pnpm-lock.yaml file.

Errors

• Error::ParseLockfile, if the data cannot be parsed as a Lockfile.

Trait Implementations

impl Debug for Lockfile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Lockfile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.