Struct Comment 

pub struct Comment {
    pub content: String,
    pub position: CommentPosition,
    pub xpath: Option<String>,
    pub line_number: Option<usize>,
    pub column_number: Option<usize>,
    pub preserve_formatting: bool,
    pub processing_hints: IndexMap<String, String>,
}

Enhanced comment structure with position and location metadata

Fields

content: String

The comment content (without markers)

position: CommentPosition

Position relative to the parent element

xpath: Option<String>

XPath-like location reference for precise positioning

line_number: Option<usize>

Line number in original XML (for debugging/tooling)

column_number: Option<usize>

Column number in original XML (for debugging/tooling)

preserve_formatting: bool

Whether this comment should be preserved during canonicalization

processing_hints: IndexMap<String, String>

Processing hints for specific output formats

Implementations

impl Comment

pub fn new(content: String, position: CommentPosition) -> Self

Create a new comment with minimal information

pub fn with_location( content: String, position: CommentPosition, xpath: Option<String>, line_number: Option<usize>, column_number: Option<usize>, ) -> Self

Create a comment with location metadata

pub fn document_comment(content: String) -> Self

Create a comment for document-level usage

pub fn preserve_formatting(self) -> Self

Set preservation of original formatting

pub fn with_hint(self, key: String, value: String) -> Self

Add a processing hint

pub fn canonical_content(&self) -> String

Get canonical comment content with proper whitespace normalization

pub fn to_xml(&self) -> String

Format as XML comment with proper escaping

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Comment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Comment

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Comment