Struct CrateExtraReader 

pub struct CrateExtraReader { /* private fields */ }

Builder for reading CrateExtra data from a crate’s source directory.

Allows selective reading of README files and examples.

Implementations

impl CrateExtraReader

pub fn new() -> Self

Creates a new CrateExtraReader with default settings, which will attempt to read the main README file and examples from the examples/ directory.

pub fn no_readme(self) -> Self

Disables reading of the crate’s main README file (README.md or README).

pub fn no_examples(self) -> Self

Disables reading of example files from the examples/ directory and its README.

pub fn read( &self, manifest: &CargoManifest, package_dir: &FilePath, ) -> Result<CrateExtra>

Reads the extra crate information from the specified crate source directory.

Arguments

• manifest: A reference to the parsed Cargo.toml of the package.
• package_dir: The path to the root directory of the package.

Returns

A Result containing the CrateExtra data, or an error if reading fails.

Trait Implementations

impl Debug for CrateExtraReader

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

Formats the value using the given formatter.

impl Default for CrateExtraReader

fn default() -> CrateExtraReader

Returns the “default value” for a type.