Struct rustdoc_json::Builder

pub struct Builder { /* private fields */ }

Builds rustdoc JSON. There are many build options. Refer to the docs to learn about them all. See top-level docs for an example on how to use this builder.

Implementations

impl Builder

pub fn toolchain(self, toolchain: impl Into<String>) -> Self

Set the toolchain. Default: None. Until rustdoc JSON has stabilized, you will want to set this to be "nightly" or similar.

If the toolchain is set as None, the current active toolchain will be used.

Notes

The currently active toolchain is typically specified by the RUSTUP_TOOLCHAIN environment variable, which the rustup proxy mechanism sets. See https://rust-lang.github.io/rustup/overrides.html for more info on how the active toolchain is determined.

pub fn clear_toolchain(self) -> Self

Clear a toolchain previously set with Self::toolchain.

pub fn manifest_path(self, manifest_path: impl AsRef<Path>) -> Self

Set the relative or absolute path to Cargo.toml. Default: Cargo.toml

pub fn target_dir(self, target_dir: impl AsRef<Path>) -> Self

Set what --target-dir to pass to cargo. Typically only needed if you want to be able to build rustdoc JSON for the same crate concurrently, for example to parallelize regression tests.

pub fn clear_target_dir(self) -> Self

Clear a target dir previously set with Self::target_dir.

pub const fn quiet(self, quiet: bool) -> Self

Whether or not to pass --quiet to cargo rustdoc. Default: false

pub const fn silent(self, silent: bool) -> Self

Whether or not to redirect stdout and stderr to /dev/null. Default: false

pub fn target(self, target: String) -> Self

Whether or not to pass --target to cargo rustdoc. Default: None

pub const fn no_default_features(self, no_default_features: bool) -> Self

Whether to pass --no-default-features to cargo rustdoc. Default: false

pub const fn all_features(self, all_features: bool) -> Self

Whether to pass --all-features to cargo rustdoc. Default: false

pub fn features<I: IntoIterator<Item = S>, S: AsRef<str>>( self, features: I ) -> Self

Features to pass to cargo rustdoc via --features. Default to an empty vector

pub fn package(self, package: impl AsRef<str>) -> Self

Package to use for cargo rustdoc via -p. Default: None

pub fn package_target(self, package_target: PackageTarget) -> Self

What part of the package to document. Default: PackageTarget::Lib

pub fn document_private_items(self, document_private_items: bool) -> Self

Whether to pass --document-private-items to cargo rustdoc. Default: false

pub fn cap_lints(self, cap_lints: Option<impl AsRef<str>>) -> Self

What to pass as --cap-lints to rustdoc JSON build command

pub fn build(self) -> Result<PathBuf, BuildError>

Generate rustdoc JSON for a library crate. Returns the path to the freshly built rustdoc JSON file.

See top-level docs for an example on how to use it.

Errors

E.g. if building the JSON fails or if the manifest path does not exist or is invalid.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.