Struct Documented 

pub struct Documented<T> {
    pub value: T,
    pub doc: Option<Vec<String>>,
}

A value with documentation metadata.

This is a metadata container - it serializes transparently as just the value, but formats that support metadata (like Styx) can emit the doc comments.

Example

let config = Config {
    port: Documented {
        value: 8080,
        doc: Some(vec!["The port to listen on".into()]),
    },
};

// JSON (no metadata support): {"port": 8080}
// Styx (with metadata support):
// /// The port to listen on
// port 8080

Fields

value: T

The actual value.

doc: Option<Vec<String>>

Documentation lines (each line is a separate string).

Implementations

impl<T> Documented<T>

pub fn new(value: T) -> Self

Create a new documented value without any documentation.

pub fn with_doc(value: T, doc: Vec<String>) -> Self

Create a new documented value with documentation.

pub fn with_doc_line(value: T, line: impl Into<String>) -> Self

Create a new documented value with a single line of documentation.

pub fn value(&self) -> &T

Get a reference to the inner value.

pub fn value_mut(&mut self) -> &mut T

Get a mutable reference to the inner value.

pub fn into_inner(self) -> T

Unwrap into the inner value, discarding documentation.

pub fn doc(&self) -> Option<&[String]>

Get the documentation lines, if any.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Documented<U>

Map the inner value to a new type.

Trait Implementations

impl<T: Clone> Clone for Documented<T>

fn clone(&self) -> Documented<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Documented<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Documented<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Documented<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Documented<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'ʄ, T> Facet<'ʄ> for Documented<T>

where T: Facet<'ʄ>,

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl<T> From<T> for Documented<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Documented<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for Documented<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for Documented<T>