Index of Rust items

Crates | Enums | Executables | Functions | Macros | Modules | Structs | Traits | Types | Variables

	Crates
	crate sphinx-rustdocgen	Library for the docextractor executable.
	Enums
	enum FileType (in sphinx-rustdocgen)	The different types of files that can be encountered.
	Bin	A binary executable's source file.
	Lib	The crate's library file.
	Mod	All other module files.
	enum Directive (in sphinx-rustdocgen::directives)	The Sphinx directives that are implemented by the Rust domain.
	Crate
	Enum
	Executable
	ForeignMod
	Function
	Impl
	Macro
	Module
	Struct
	Trait
	Type
	Use
	Variable
	enum DirectiveOption (in sphinx-rustdocgen::directives)	Enum to represent the various options for the directives.
	Index	The ``:index:`` option
	Layout	The ``:layout:`` option.
	Toc	The ``:toc:`` option.
	Vis	The ``:vis:`` option.
	enum DirectiveVisibility (in sphinx-rustdocgen::directives)	Enum for the values of the
	Crate
	Pub
	Pvt
	enum IndexEntryType (in sphinx-rustdocgen::directives)	The different index entry types.
	None
	Normal
	SubEntry
	WithSubEntries
	enum Format (in sphinx-rustdocgen::formats)	Supported formats for the docstrings
	Md	Markdown format
	Rst	reStructuredText format
	enum Node (in sphinx-rustdocgen::nodes)	Enum representing various docutils nodes for item signatures
	Indent	A node for adding an indentation before the line.
	Keyword	A node for a keyword in the signature.
	Lifetime	A node for a lifetime name. This is not a docutils node, but kept
	Link	A node for link to another item in the signature.
	Literal	A literal string to include in the signature.
	Name	The node for a name in the signature.
	Newline	A node for a newline in the signature.
	Operator	A node for an operator in the signature.
	Punctuation	A node for a punctuation in the signature.
	Returns	A node for the returns symbol.
	Space	A node for a single space in the signature.
	Executables
	sphinx-rustdocgen	sphinx-rustdocgen is an executable to extract doc comments from Rust
	Functions
	fn extract_doc_from_attrs (in sphinx-rustdocgen::directives)	Extract the docstring from the attrs of an item.
	fn nodes_for_fn_signature (in sphinx-rustdocgen::directives::function_directive)	Generate docutils node layout for the function from its signature
	fn nodes_for_impl (in sphinx-rustdocgen::directives::impl_directive)	Generate docutils nodes for the impl block's signature.
	fn has_test_token (in sphinx-rustdocgen::directives::module_directive)
	fn is_test_module (in sphinx-rustdocgen::directives::module_directive)	Determines if the module is a test module or not.
	fn order_items (in sphinx-rustdocgen::directives)	Order the items for documentation
	fn find_mod_file (in sphinx-rustdocgen)	Find the file for the module from provided parent path.
	fn find_mod_file_under (in sphinx-rustdocgen)	Find the file for the module under the parent directory.
	fn generate_decoration (in sphinx-rustdocgen::formats)	Generate title decoration string for RST or fence for MD.
	fn main (in sphinx-rustdocgen)
	fn nodes_for_abi_opt (in sphinx-rustdocgen::nodes)	Create nodes for an optional ABI specification.
	fn nodes_for_angle_bracket_generic_args (in sphinx-rustdocgen::nodes)	Create nodes for angle bracket generic arguments in paths.
	fn nodes_for_bare_fn (in sphinx-rustdocgen::nodes)	Create nodes for a bare fn type.
	fn nodes_for_bound_lifetimes (in sphinx-rustdocgen::nodes)	Create nodes for bound lifetimes.
	fn nodes_for_expr_lit (in sphinx-rustdocgen::nodes)	Create nodes for a literal expression.
	fn nodes_for_generic_argument (in sphinx-rustdocgen::nodes)	Create nodes for a generic argument.
	fn nodes_for_generic_param (in sphinx-rustdocgen::nodes)	Create nodes for a generic parameter, along with its bounds.
	fn nodes_for_generics (in sphinx-rustdocgen::nodes)	Create nodes for generics declared for an item.
	fn nodes_for_lifetime_param (in sphinx-rustdocgen::nodes)	Create nodes for a lifetime parameter.
	fn nodes_for_parenthesized_generic_args (in sphinx-rustdocgen::nodes)	Create nodes for parenthesized generic arguments in paths.
	fn nodes_for_pat (in sphinx-rustdocgen::nodes)	Create nodes for a pattern binding.
	fn nodes_for_pat_type (in sphinx-rustdocgen::nodes)	Create nodes for a type pattern binding.
	fn nodes_for_path (in sphinx-rustdocgen::nodes)	Create nodes for a path.
	fn nodes_for_path_segment (in sphinx-rustdocgen::nodes)	Create nodes for a path segment.
	fn nodes_for_return_type (in sphinx-rustdocgen::nodes)	Create nodes for the return type of function.
	fn nodes_for_type (in sphinx-rustdocgen::nodes)	Create nodes for a type specification.
	fn nodes_for_type_param (in sphinx-rustdocgen::nodes)	Create nodes for a type parameter, along with its bounds.
	fn nodes_for_type_param_bound (in sphinx-rustdocgen::nodes)	Create nodes for a type parameter binding.
	fn nodes_for_type_param_bounds (in sphinx-rustdocgen::nodes)	Create nodes for all type parameters in a binding.
	fn nodes_for_where_clause (in sphinx-rustdocgen::nodes)	Create nodes for the where clause of generics for an item.
	fn type_name (in sphinx-rustdocgen::nodes)	Get simple name for a type.
	fn type_param_bound_name (in sphinx-rustdocgen::nodes)	Get simple name for a type parameter bound
	fn traverse_crate (in sphinx-rustdocgen)	Traverse the crate and extract the docstrings for the items.
	Macros
	macro check_visibility (in sphinx-rustdocgen::directives)	Check the options to determine if the visibility of a directive matches
	macro func_from_item (in sphinx-rustdocgen::directives::function_directive)	DRY macro to parse the different item types.
	macro push_sorted (in sphinx-rustdocgen::directives)
	macro make_nodes (in sphinx-rustdocgen::directives::struct_directive)
	macro type_from_item (in sphinx-rustdocgen::directives::type_directive)
	macro var_from_item (in sphinx-rustdocgen::directives::variable_directive)
	macro visibility_to_inherit (in sphinx-rustdocgen::directives)	DRY macro to check which visibility value to pass to inner items.
	macro push_module_files (in sphinx-rustdocgen)	Macro to push the module files to the files vec for processing
	Modules
	module directives (in sphinx-rustdocgen)	Module for the various Sphinx directives for the Rust domain.
	module crate_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:crate`` directive.
	module enum_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:enum`` directive
	module executable_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:executable`` directive.
	module foreign_mod (in sphinx-rustdocgen::directives)	Implementation of the pseudo-directive for foreign modules.
	module function_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:function`` directive
	module impl_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:impl`` directive
	module macro_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:macro`` directive
	module module_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:module`` directive
	module struct_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:struct`` directive
	module trait_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:trait`` directive
	module type_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:type`` directive
	module use_directive (in sphinx-rustdocgen::directives)
	module variable_directive (in sphinx-rustdocgen::directives)	Implementation of the ``rust:variable`` directive
	module formats (in sphinx-rustdocgen)	Module for handling the output formats supported.
	module nodes (in sphinx-rustdocgen)	Module for generating a semi-structured representation of Rust signatures.
	Structs
	struct Configuration (in sphinx-rustdocgen)
	crate_name
	doc_dir
	force
	format
	src_dir
	visibility
	struct CrateDirective (in sphinx-rustdocgen::directives::crate_directive)	Struct to hold data required for documenting a crate.
	content	The docstring for the crate's lib.rs file.
	items	The items within the crate's lib.rs file.
	name	The name of the crate.
	options	The options for the crate directive.
	struct EnumDirective (in sphinx-rustdocgen::directives::enum_directive)	Struct to hold data for documenting an enum
	content	The docstring for the enum.
	name	The full Rust path of the enum, used as the name of the directive.
	options	The directive options to use.
	variants	The variants within the enum.
	struct ExecutableDirective (in sphinx-rustdocgen::directives::executable_directive)	Struct to hold data required for documenting an executable.
	content	The docstring for the executable's main file.
	items	The items within the executable.
	name	The name of the executable.
	options	The options for the executable directive.
	struct ForeignModDirective (in sphinx-rustdocgen::directives::foreign_mod)
	items
	struct FunctionDirective (in sphinx-rustdocgen::directives::function_directive)	Struct to hold data for documenting a function.
	content	The docstring for the function.
	name	The full Rust path of the function.
	options	The directive options to use.
	struct ImplDirective (in sphinx-rustdocgen::directives::impl_directive)
	content
	items
	name
	options
	struct MacroDirective (in sphinx-rustdocgen::directives::macro_directive)
	content
	name
	options
	struct ModuleDirective (in sphinx-rustdocgen::directives::module_directive)	Struct to hold data for a module's documentation.
	content	The docstring for the module.
	ident	The identifier of the module (i.e. the final portion of name).
	items	The items defined within the module.
	name	The full path to the module.
	options	The options for the module directive.
	visibility	The visibility of the module.
	struct StructDirective (in sphinx-rustdocgen::directives::struct_directive)
	content
	fields
	name
	options
	struct TraitDirective (in sphinx-rustdocgen::directives::trait_directive)
	content
	items
	name
	options
	struct TypeDirective (in sphinx-rustdocgen::directives::type_directive)
	content
	name
	options
	struct UseDirective (in sphinx-rustdocgen::directives::use_directive)
	paths
	struct UsePath (in sphinx-rustdocgen::directives::use_directive)
	path
	target
	struct VariableDirective (in sphinx-rustdocgen::directives::variable_directive)
	content
	name
	options
	Traits
	trait MdContent (in sphinx-rustdocgen::formats)	Trait for anything that can be converted to MD directive content.
	fn get_md_text
	trait MdDirective (in sphinx-rustdocgen::formats)	Trait for directives that can be written as MD content
	fn calc_fence_size	Calculate the fence size required for the item.
	fn fence_size	Return the fence size required for documenting the item.
	fn get_md_text	Generate MD text with the given fence size.
	fn make_fence	Make a string for the fences for the directive.
	fn make_md_header	Make the MD directive header from the directive, name and options.
	fn make_md_section
	fn make_md_toctree	Make a ``toctree`` directive for MD documents.
	trait MdOption (in sphinx-rustdocgen::formats)	Trait for MD directive options
	fn get_md_text
	trait RstContent (in sphinx-rustdocgen::formats)	Trait for anything that can be converted to RST directive content.
	fn get_rst_text
	trait RstDirective (in sphinx-rustdocgen::formats)	Trait for directives that can be written as RST content
	fn get_rst_text	Generate RST text with the given level of indentation.
	fn make_content_indent	Make a string for indenting the directive's content and options
	fn make_indent	Make a string for indenting the directive.
	fn make_rst_header	Make the RST directive header from the directive, name and options.
	fn make_rst_section
	fn make_rst_toctree	Make a ``toctree`` directive for RST documents.
	trait RstOption (in sphinx-rustdocgen::formats)	Trait for RST directive options
	fn get_rst_text
	Types
	type DocStructure (in sphinx-rustdocgen::directives)	Named tuple type for the output of :rust:fn:`order_items`.
	Variables
	static USAGE (in sphinx-rustdocgen)