Struct CanonicalRender 

pub struct CanonicalRender { /* private fields */ }

The result of deterministic canonical rendering.

The output can contain interpolated secrets and is therefore available only through explicit accessors. Its Debug representation redacts the complete output when any rendered value is sensitive.

Implementations

impl CanonicalRender

pub fn output(&self) -> &str

Returns the rendered UTF-8 YAML document.

pub fn into_output(self) -> String

Consumes the result and returns the rendered document.

pub fn diagnostics(&self) -> &[Diagnostic]

Returns canonical-rendering diagnostics.

pub fn is_valid(&self) -> bool

Reports whether the renderer emitted no error diagnostics.

pub const fn is_sensitive(&self) -> bool

Reports whether any rendered value contains sensitive interpolation output.

Trait Implementations

impl Clone for CanonicalRender

fn clone(&self) -> CanonicalRender

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalRender

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

Formats the value using the given formatter.

impl Eq for CanonicalRender

impl PartialEq for CanonicalRender

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CanonicalRender