Struct Commented 

pub struct Commented<T> {
    pub value: T,
    pub comment: String,
}

Attach an inline YAML comment # ... after a value.

The comment text should not include the # prefix.

Note: Comments are serialization-only metadata. When deserializing, the comment field is always empty because YAML comments are not part of the data model and cannot survive a roundtrip.

Examples

use noyalib::{to_string, Commented};
use serde::Serialize;
#[derive(Serialize)]
struct Doc { v: Commented<i32> }
let yaml = to_string(&Doc { v: Commented::new(42, "meaning") }).unwrap();
assert!(yaml.contains("# meaning"));

Fields

value: T

The inner value.

comment: String

The comment text (without # prefix).

Implementations

impl<T> Commented<T>

pub fn new(value: T, comment: impl Into<String>) -> Self

Create a new commented value.

Examples

use noyalib::Commented;
let c = Commented::new(42, "the answer");
assert_eq!(c.value, 42);
assert_eq!(c.comment, "the answer");

pub fn into_inner(self) -> T

Unwrap into the inner value.

Examples

use noyalib::Commented;
let c = Commented::new(7, "note");
assert_eq!(c.into_inner(), 7);

Trait Implementations

impl<T: Clone> Clone for Commented<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Commented<T>

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

Formats the value using the given formatter.

impl<T> Deref for Commented<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Commented<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Commented<T>

impl<T: Hash> Hash for Commented<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 Commented<T>

fn eq(&self, other: &Commented<T>) -> 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: Serialize> Serialize for Commented<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Commented<T>