Skip to main content

Module description

Module description 

Source
Expand description

The R package’s DESCRIPTION: its name and the packages it declares.

Found from the Cargo manifest directory in the standard layout, where the crate lives at <pkg>/src/rust and DESCRIPTION at <pkg>/DESCRIPTION. Anywhere else (a plain Rust crate, a custom layout) there is none, and the rules that need it skip.

Structs§

Description
What the lint reads from a DESCRIPTION.

Constants§

DEPENDENCY_FIELDS 🔒
The DESCRIPTION fields that declare a package dependency.
R_DISTRIBUTED_PACKAGES 🔒
Packages shipped with R (base and recommended), which every R install has.

Functions§

fields 🔒
(field, value) pairs; a line starting with whitespace continues the value.
locate
The DESCRIPTION file of the R package whose Rust crate sits in manifest_dir, when there is one.
read
Read and parse the DESCRIPTION of the package around manifest_dir.