Struct LockedPackage 

pub struct LockedPackage {

    pub key: String,
    pub name: String,
    pub version: String,
    pub resolved: Option<String>,
    pub integrity: Option<String>,
    pub license: Option<String>,
    pub dev: bool,
    pub optional: bool,
    pub dev_optional: bool,
    pub link: bool,
    pub os: Vec<String>,
    pub cpu: Vec<String>,
    pub bin: Vec<(String, String)>,
}

One entry of the packages map.

Fields

key: String

The map key: "" for the root project, else a node_modules/…-relative path.

name: String

The package name — the segment after the last node_modules/ (empty for the root).

version: String

version from the entry (empty for the root or a pure link).

resolved: Option<String>

resolved — the registry URL, git source, or file: path; None if absent.

integrity: Option<String>

integrity — the Subresource-Integrity string (sha512-…); None if absent.

license: Option<String>

license — the package’s declared SPDX license string, when the lockfile records one (npm writes it per package; so does this crate’s render_v3). None if absent. Read so SBOM/compliance output (crate::sbom) can carry it.

dev: bool

dev — strictly in the devDependencies tree.

optional: bool

optional — strictly in the optionalDependencies tree.

dev_optional: bool

devOptional — both a dev and an optional dependency.

link: bool

link: true — a symlink to a local path; nothing is fetched.

os: Vec<String>

os constraints (npm spelling — darwin, linux, win32; !-negation allowed).

cpu: Vec<String>

cpu constraints (npm spelling — x64, arm64, ia32; !-negation allowed).

bin: Vec<(String, String)>

bin as (name, path-within-package) pairs.

Implementations

impl LockedPackage

pub fn is_registry_tarball(&self) -> bool

Whether resolved is an http(s) registry tarball — the only source npm-utils fetches.

pub fn matches_platform(&self, host_os: &str, host_arch: &str) -> bool

Whether the host satisfies this entry’s os/cpu. host_os/host_arch are Rust’s std::env::consts::{OS, ARCH}; they are mapped to npm’s spelling before comparing.

Trait Implementations

impl Clone for LockedPackage

fn clone(&self) -> LockedPackage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LockedPackage

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

Formats the value using the given formatter.

impl License for LockedPackage

fn license(&self) -> Option<String>

The license the lockfile recorded for this package, if any.