Struct Config

pub struct Config {
    pub crate_name: String,
    pub item_path: Option<String>,
    pub online: bool,
}

Configuration options for fetching Rust documentation.

Fields

crate_name: String

The name of the crate to fetch documentation for.

item_path: Option<String>

Optional path to a specific item within the crate.

online: bool

Whether to fetch documentation from docs.rs instead of building locally.

Implementations

impl Config

pub fn new<S: Into<String>>(crate_name: S) -> Self

Create a new configuration with the specified crate name.

Arguments

• crate_name - The name of the crate to fetch documentation for

Examples

use rustdoc_text::Config;

let config = Config::new("serde");
assert_eq!(config.crate_name, "serde");
assert_eq!(config.online, false);

pub fn with_item_path<S: Into<String>>(self, item_path: S) -> Self

Set the item path for the configuration.

Arguments

• item_path - The item path within the crate

Examples

use rustdoc_text::Config;

let config = Config::new("serde").with_item_path("Deserializer");
assert_eq!(config.item_path, Some("Deserializer".to_string()));

pub fn with_online(self, online: bool) -> Self

Set whether to fetch documentation from docs.rs.

Arguments

• online - Whether to fetch documentation from docs.rs

Examples

use rustdoc_text::Config;

let config = Config::new("serde").with_online(true);
assert_eq!(config.online, true);

pub fn execute(&self) -> Result<String>

Execute the configuration to fetch documentation.

Returns

The documentation as Markdown text.

Examples

use rustdoc_text::Config;

let docs = Config::new("serde")
    .with_online(true)
    .with_item_path("Deserializer")
    .execute()?;
println!("{}", docs);