Enum CommentPolicy 

pub enum CommentPolicy {
    TreatAsError,
    Remove,
    Preserve,
}

Policy for handling comments in JSON input.

Standard JSON does not support comments, but many JSON-like formats (such as JSONC used by VS Code) do allow them. This enum controls how comments are handled during formatting.

Variants

TreatAsError

Return an error if comments are encountered in the input. This is the default, enforcing strict JSON compliance.

Remove

Silently remove any comments from the output.

Preserve

Keep comments in the output, preserving their relative positions.

Trait Implementations

impl Clone for CommentPolicy

fn clone(&self) -> CommentPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentPolicy

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

Formats the value using the given formatter.

impl PartialEq for CommentPolicy

fn eq(&self, other: &CommentPolicy) -> 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 Copy for CommentPolicy

impl Eq for CommentPolicy

impl StructuralPartialEq for CommentPolicy