Module format 

HTML formatting module

This module contains a large number of Display implementations for various types in rustdoc::clean.

These implementations all emit HTML. As an internal implementation detail, some of them support an alternate format that emits text, but that should not be used external to this module.

Structs

HrefInfo 🔒

Type representing information of an href attribute.

Indent 🔒

WriteCounter 🔒

Enums

Ending 🔒

HrefError 🔒

Traits

PrintWithSpace 🔒

Functions

fmt_type 🔒

full_print_fn_decl 🔒

header_len: The length of the function header and name. In other words, the number of characters in the function declaration up to but not including the parentheses. This is expected to go into a <pre>/code-header block, so indentation and newlines are preserved.indent: The number of spaces to indent each successive line with, if line-wrapping is necessary.

generate_item_def_id_path 🔒

generate_macro_def_id_path 🔒

This function is to get the external macro path because they are not in the cache used in href_with_root_path.

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 🔒

is_unnamable 🔒

Checks if the given defid refers to an item that is unnamable, such as one defined in a const block.

link_tooltip 🔒

make_href 🔒

primitive_link 🔒

primitive_link_fragment 🔒

print_abi_with_space 🔒

print_anchor 🔒

print_assoc_item_constraint 🔒

print_constant_kind 🔒

print_constness_with_space 🔒

print_default_space 🔒

print_fn_decl 🔒

print_generic_arg 🔒

print_generic_args 🔒

print_generic_bound 🔒

print_generic_bounds 🔒

print_generic_param_def 🔒

print_generics 🔒

print_higher_ranked_params_with_space 🔒

print_impl 🔒

print_import 🔒

print_import_source 🔒

print_lifetime 🔒

print_parameter 🔒

print_params 🔒

print_path 🔒

print_poly_trait 🔒

print_qpath_data 🔒

print_term 🔒

print_tybounds 🔒

print_type 🔒

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.

print_where_predicate 🔒

resolved_path 🔒

Used to render a clean::Path.

to_module_fqp 🔒

url_parts 🔒

visibility_print_with_space 🔒