Struct Package

pub struct Package {

    pub name: String,
    pub version: String,
    pub description: Option<String>,
    pub keywords: Vec<String>,
    pub homepage: Option<String>,
    pub bugs: Option<Bug>,
    pub license: Option<String>,
    pub author: Option<PersonReference>,
    pub contributors: Vec<PersonReference>,
    pub files: Vec<String>,
    pub main: Option<String>,
    pub browser: Option<String>,
    pub bin: BinSet,
    pub man: Option<ManReference>,
    pub repository: Option<RepositoryReference>,
    pub scripts: ScriptsSet,
    pub dependencies: DepsSet,
    pub dev_dependencies: DepsSet,
    pub peer_dependencies: DepsSet,
    pub bundled_dependencies: DepsSet,
    pub optional_dependencies: DepsSet,
    pub engines: EnginesSet,
    pub private: bool,
    pub os: Vec<String>,
    pub cpu: Vec<String>,
    pub config: Option<Value>,
    pub others: BTreeMap<String, Value>,
}

The top-level package.json structure.

Fields

name: String

The package name.

version: String

The package version.

description: Option<String>

The optional package description.

keywords: Vec<String>

The optional list of keywords.

homepage: Option<String>

The optional package homepage.

bugs: Option<Bug>

The optional bug contact form.

license: Option<String>

The optional package license.

author: Option<PersonReference>

The optional author.

contributors: Vec<PersonReference>

The optional list of contributors.

files: Vec<String>

The optional list of files to include. Each entry defines a regex pattern.

main: Option<String>

The optional package main entry file.

browser: Option<String>

The optional package browser entry file.

This is usually defined in libraries that are meant to be consumed by browsers. These Thoes can refer to objects that are not available inside a nodejs environment (like window).

bin: BinSet

The optional set of binary definitions.

man: Option<ManReference>

The optional list of man page references.

repository: Option<RepositoryReference>

The optional repository reference.

scripts: ScriptsSet

The optional list of script entries.

dependencies: DepsSet

The optional list of dependencies.

dev_dependencies: DepsSet

The optional list of development dependencies.

peer_dependencies: DepsSet

The optional list of peer dependencies.

bundled_dependencies: DepsSet

The optional list of bundled dependencies.

optional_dependencies: DepsSet

The optional list of optional dependencies.

engines: EnginesSet

The optional list of engine entries.

private: bool

The package privacy.

os: Vec<String>

The OS’ that the package can run on.

cpu: Vec<String>

The CPU architectures that the package can run on.

config: Option<Value>

The optional config object.

others: BTreeMap<String, Value>

Other custom fields that have been defined inside the package.json file.

Implementations

impl Package

pub fn new() -> Self

Creates a new default package.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Deserializes a Package from a file path.

pub fn from_reader<R: Read>(r: R) -> Result<Self>

Deserializes a Package from an IO stream.

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

Deserializes a Package from bytes.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Package

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Package

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for Package

fn from_str(s: &str) -> Result<Self, Self::Err>

Deserializes a Package from a string.

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Package

fn eq(&self, other: &Package) -> 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 Serialize for Package

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Package

impl StructuralPartialEq for Package