Struct CaveatDeferred 

pub struct CaveatDeferred<T, W: Warning> { /* private fields */ }

A value that may have associated Warnings.

This caveat is considered deferred as the warning still need to be associated with a json::Element to become Warnings.

Even though the value has been created there may be certain caveats you should be aware of before using it.

NOTE: The deferred types are used to avoid passing json::Element references to functions just to create Warnings.

Implementations

impl<T, W> CaveatDeferred<T, W>

where W: Warning,

pub fn into_parts(self) -> (T, SetDeferred<W>)

Return the value and any Warnings stored in the CaveatDeferred.

pub fn ignore_warnings(self) -> T

Return the value and drop any warnings contained within.

Trait Implementations

impl<T: Debug, W: Debug + Warning> Debug for CaveatDeferred<T, W>

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

Formats the value using the given formatter.

impl<T, W> Deref for CaveatDeferred<T, W>

where W: Warning,

A deferred Caveat is simply a value with associated Warnings that still need to be associated with a json::Element.

Providing an impl Deref makes sense for given that it’s an annotated value.

The same advice applies to both deref traits. In general, deref traits should be implemented if:

1. a value of the type transparently behaves like a value of the target type;
2. the implementation of the deref function is cheap; and
3. users of the type will not be surprised by any deref coercion behavior.

See: https://doc.rust-lang.org/std/ops/trait.Deref.html#when-to-implement-deref-or-derefmut.

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, W: Warning> WithElement<T, W> for CaveatDeferred<T, W>

fn with_element(self, element: &Element<'_>) -> Self::Output

Associate a json::Element with a set of Warnings.

type Output = Caveat<T, W>