Struct Comment 

pub struct Comment<'a> { /* private fields */ }

A validated comment: the text without the outer parentheses, and the deepest nesting reached.

Examples

use parse_net::{text::parse_comment, Limits};

let (c, _) = parse_comment(b"(a(b))", &Limits::DEFAULT)?;
assert_eq!((c.raw(), c.max_depth()), (&b"a(b)"[..], 2));

Implementations

impl<'a> Comment<'a>

pub const fn raw(&self) -> &'a [u8]

The text between the outer parentheses, as sent.

Examples

use parse_net::{text::parse_comment, Limits};

let (c, _) = parse_comment(b"(gzip; level 9) x", &Limits::DEFAULT)?;
assert_eq!(c.raw(), b"gzip; level 9");

pub const fn max_depth(&self) -> u8

The deepest nesting reached: 1 for (a), 2 for (a(b)).

Examples

use parse_net::{text::parse_comment, Limits};

assert_eq!(parse_comment(b"(a)", &Limits::DEFAULT)?.0.max_depth(), 1);
assert_eq!(parse_comment(b"(a(b(c)) d)", &Limits::DEFAULT)?.0.max_depth(), 3);

Trait Implementations

impl<'a> Clone for Comment<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Comment<'a>

impl<'a> Debug for Comment<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Comment<'a>

impl<'a> Hash for Comment<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Comment<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Comment<'a>