Struct structdoc::Documentation

pub struct Documentation(_);

A representation of documentation.

This carries the internal representation (tree) of a documentation. Note that currently this does not support cycles or referencing other branches.

This can be either queried by the StructDoc trait, or manually constructed (which might be needed in a manual implementation of the trait).

TODO

Currently, the documentation can be formatted both with the Debug and Display traits, but doesn't offer any kind of customization. In the future it should be possible to both traverse the structure manually and to customize the way the documentation is formatted.

Implementations

impl Documentation

pub fn leaf_empty() -> Documentation

Creates a leaf node of the documentation, without any description.

pub fn leaf(ty: impl Into<Text>) -> Documentation

Creates a leaf node with the given type.

Note that an empty ty is equivalent to the leaf_empty.

pub fn set_flag(&mut self, flag: Flags)

Adds a flag to this documentation node.

pub fn with_arity(self, arity: Arity) -> Self

Wraps a node into an array or a set.

This describes a homogeneous collection.

pub fn map(key: Documentation, value: Documentation) -> Self

Builds a map.

Joins documentation of keys and values into a map. Note that all the keys and all the values are of the same type ‒ for heterogeneous things, you might want structs or enums.

pub fn struct_(
    fields: impl IntoIterator<Item = (impl Into<Text>, Field)>
) -> Self

Builds a struct.

Builds a structure, provided a list of fields.

The iterator should yield pairs of (name, field).

pub fn enum_(
    variants: impl IntoIterator<Item = (impl Into<Text>, Field)>,
    tagging: Tagging
) -> Self

Builds an enum.

Builds an enum from provided list of fields. The fields may be either leaves (without things inside ‒ created with eg. leaf_empty), newtypes (other leaves) or structs. The iterator should yield pairs of (name, variant).

See the serde documentation about enum representations for tagging.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Documentation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Documentation

fn fmt(&self, fmt: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter.