Struct smoljson::read::Dialect

#[non_exhaustive]
pub struct Dialect {
    pub allow_comments: bool,
}

A set of flags describing non-standard extensions to JSON.

Currently, this is just comments, but trailing commas may be added in the future.

Note: turning one of these flags on should never cause documents which were valid with that flag off to become invalid.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_comments: bool

Allow JavaScript-style comments.

That is, if this is true, it ignores the text between single line comments like // foo, and block comments like /* bar */.

Note that unlike Rust’s block comments, JavaScript’s (and, by extension, Dialect::CJSON’s), cannot be nested. E.g. /* /* this */ */ is invalid.

Implementations

impl Dialect

pub const STRICT: Self

Fully standard JSON (no extensions).

pub const CJSON: Self

“JSON with Comments”, as understood by Visual Studio Code.

This is standard/strict JSON, but with support for JavaScript’s comment syntax.

See https://github.com/microsoft/node-jsonc-parser for more details.

pub const DEFAULT: Self

The default settings.

This is used with the plain Reader::new, when using s.parse::<Value>() (or Value::from_str), etc. It can be controlled by cargo features.

The settings here can be controlled by cargo features.

• features = ["default_allow_comments"]: enables Dialect::allow_comments by default.

pub const LOOSE: Self

All extensions enabled.

When new options are added, this constant will be updated to have them set to true.

Use of this is not always the best idea, as there’s no telling what kind of terrible extension the fool who maintains this crate decides to add in the future…

(That said, the dialect flags are intended to be strictly additive — they should never cause documents that parsed without the flag to fail to parse with it, so using this shouldn’t cause your code to unexpectedly break)

pub const fn comments(self, v: bool) -> Self

Trait Implementations

impl Clone for Dialect

fn clone(&self) -> Dialect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dialect

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

Formats the value using the given formatter.

impl Default for Dialect

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Dialect> for Dialect

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Dialect

impl Eq for Dialect

impl StructuralEq for Dialect

impl StructuralPartialEq for Dialect