Module rustdoc::html::format[−][src]

Expand description

HTML formatting module

This module contains a large number of fmt::Display implementations for various types in rustdoc::clean. These implementations all currently assume that HTML output is desired, although it may be possible to redesign them in the future to instead emit any format desired.

Structs

Buffer

Enums

HrefError

Traits

Print
PrintWithSpace

Functions

anchor
comma_sep
display_fn
fmt_type
href
href_relative_parts

Both paths should only be modules. This is because modules get their own directories; that is, std::vec and std::vec::Vec will both need ../iter/trait.Iterator.html to get at the iterator trait.

href_with_root_path
primitive_link
print_abi_with_space
print_constness_with_space
print_default_space
print_generic_bounds
print_where_clause

  • The Generics from which to emit a where-clause.
  • The number of spaces to indent each line with.
  • Whether the where-clause needs to add a comma and newline after the last bound.

    • resolved_path

    Used when rendering a ResolvedPath structure. This invokes the path rendering function with the necessary arguments for linking to a local path.

    tybounds

    Helper to render type parameters