Module reference 

Exposes the reference module.

Examples

use pharos_runtime_docs::reference;

Related

• crate for sibling modules in the same crate.

Constants

MAX_REFERENCE_TEXT_BYTES 🔒

Functions

LOAD_REF_FRAGMENT

Loads one reference fragment template through the current bounded rendering contract.

escape 🔒

Performs escape.

reference_actions_have_effect_hook

Returns whether an action declaration has a user-visible effect hook.

reference_append_generated_entry

Appends one generated reference entry using escaped declarative fields.

reference_append_object_key_parameter

Appends one object-key parameter to a bounded reference parameter list.

reference_append_reference_entry

Appends one reference entry to a bounded output buffer.

reference_append_toc_item

Appends one table-of-contents item with an escaped anchor target.

reference_attributes_list

Returns reference attributes as a compact JSON array.

reference_buffer_append_format

Appends formatted text to a bounded reference buffer.

reference_buffer_append_html_escaped

Appends HTML-escaped text to a bounded reference buffer.

reference_example_from_value

Converts one reference value into a compact example document.

reference_find_object_by_string_field

Finds an object by an exact string field.

reference_json_pretty

Returns stable pretty JSON for a reference value with a bounded depth/size.

reference_parameters_from_object

Extracts reference parameters from one object into compact JSON.

reference_render_fragment

Renders a reference fragment from a template value and parameter object.

reference_sidebar_group

Returns a compact sidebar group representation.

reference_sidebar_shell

Returns the escaped sidebar shell text from declarative groups.

reference_ui_preview_fragment

Renders an escaped reference preview fragment.

reference_value_summary

Summarizes one reference value without exposing uncontrolled nested data.

reference_value_type_name

Returns the stable JSON type name used by reference rendering.

request_path_without_query

Removes the query and fragment from a request target.

request_target_for_mount

Resolves a request target relative to an app mount path.

text 🔒

Performs text.