Struct Field

pub struct Field { /* private fields */ }

A documentation node with actual documentation text.

Implementations

impl Field

pub fn new(inner: Documentation, doc: impl Into<Text>) -> Self

Creates a field from (undocumented) documentation node and the documentation text.

This is the proper way to add descriptions to struct fields and enum variants.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.