Struct json_comments::CommentSettings

pub struct CommentSettings { /* private fields */ }

Settings for StripComments

The default is for all comment types to be enabled.

Implementations

impl CommentSettings

pub const fn all() -> Self

Enable all comment Styles

pub const fn hash_only() -> Self

Only allow line comments starting with #

pub const fn c_style() -> Self

Only allow “c-style” comments.

Specifically, line comments beginning with // and block comment like /* ... */.

pub fn strip_comments<I: Read>(self, input: I) -> StripComments<I>

Create a new StripComments for input, using these settings.

Transform input into a Read that strips out comments. The types of comments to support are determined by the configuration of self.

Examples

use json_comments::CommentSettings;
use std::io::Read;

let input = r#"{
// c line comment
"a": "b"
/** multi line
comment
*/ }"#;

let mut stripped = String::new();
CommentSettings::c_style().strip_comments(input.as_bytes()).read_to_string(&mut stripped).unwrap();

assert_eq!(stripped, "{
                 \n\"a\": \"b\"
                          }");

use json_comments::CommentSettings;
use std::io::Read;

let input = r#"{
# shell line comment
"a": "b"
}"#;

let mut stripped = String::new();
CommentSettings::hash_only().strip_comments(input.as_bytes()).read_to_string(&mut stripped).unwrap();

assert_eq!(stripped, "{
                    \n\"a\": \"b\"\n}");

Trait Implementations

impl Clone for CommentSettings

fn clone(&self) -> CommentSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentSettings

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

Formats the value using the given formatter.

impl Default for CommentSettings

fn default() -> Self

Returns the “default value” for a type.

impl Copy for CommentSettings