Struct rustdoc_json::BuildOptions

pub struct BuildOptions { /* private fields */ }

Contains all options for crate::build().

See crate for an example on how to use it.

Implementations

impl BuildOptions

pub fn toolchain(self, toolchain: impl Into<Option<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 manifest_path(self, manifest_path: impl AsRef<Path>) -> Self

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

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

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

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

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

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

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

pub 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

Trait Implementations

impl Debug for BuildOptions

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

Formats the value using the given formatter.

impl Default for BuildOptions

fn default() -> Self

Returns the “default value” for a type.