Struct RendererUtils 

pub struct RendererUtils;

Unit struct to organize path related utility functions related to renderer functions.

Implementations

impl RendererUtils

pub fn sanitize_path(path: &str) -> Cow<'_, str>

Sanitize trait paths by removing macro artifacts.

Rustdoc JSON can contain $crate:: prefixes from macro expansions which leak implementation details into documentation. This function removes these artifacts for cleaner output.

Uses Cow<str> to avoid allocation when no changes are needed.

Examples

use cargo_docs_md::generator::render_shared::RendererUtils;

assert_eq!(RendererUtils::sanitize_path("$crate::clone::Clone"), "clone::Clone");
assert_eq!(RendererUtils::sanitize_path("std::fmt::Debug"), "std::fmt::Debug");

pub fn sanitize_self_param(param: &str) -> Cow<'_, str>

Sanitize self parameter in function signatures.

Converts verbose self type annotations to idiomatic Rust syntax:

• self: &Self → &self
• self: &mut Self → &mut self
• self: Self → self

Uses Cow<str> to avoid allocation when no changes are needed.

Examples

use cargo_docs_md::generator::render_shared::RendererUtils;

assert_eq!(RendererUtils::sanitize_self_param("self: &Self"), "&self");
assert_eq!(RendererUtils::sanitize_self_param("self: &mut Self"), "&mut self");
assert_eq!(RendererUtils::sanitize_self_param("self: Self"), "self");
assert_eq!(RendererUtils::sanitize_self_param("x: i32"), "x: i32");

pub fn write_tuple_fields( out: &mut String, fields: &[Option<Id>], krate: &Crate, type_renderer: &TypeRenderer<'_>, )

Write tuple field types directly to buffer, comma-separated.

Avoids intermediate Vec allocation by writing directly to the output buffer. Handles Option<Id> fields from rustdoc’s representation of tuple structs/variants (where None indicates a private field).

Arguments

• out - Output buffer to write to
• fields - Slice of optional field IDs from rustdoc
• krate - Crate containing field definitions
• type_renderer - Type renderer for field types

pub fn transform_cargo_path( absolute_path: &Path, source_dir_name: &str, ) -> Option<String>

Transform an absolute cargo registry path to a relative .source_* path.

Converts paths like: /home/user/.cargo/registry/src/index.crates.io-xxx/serde-1.0.228/src/lib.rs

To: .source_1733660400/serde-1.0.228/src/lib.rs

Returns None if the path doesn’t match the expected cargo registry pattern.