Struct Mark

pub struct Mark {
    pub sys: YamlMarkT,
}

Represents a mark in a YAML document. A mark indicates a specific position or location within the document.

Fields

sys: YamlMarkT

The underlying system representation of the mark.

This field is marked as pub(super), which means it is accessible within the current module and its parent module, but not from outside the crate.

Implementations

impl Mark

pub fn index(&self) -> u64

Retrieves the index of the mark.

The index represents the position of the mark within the YAML input.

Returns

Returns the index of the mark as a u64.

pub fn line(&self) -> u64

Retrieves the line number of the mark.

The line number indicates the line in the YAML input where the mark is located.

Returns

Returns the line number of the mark as a u64.

pub fn column(&self) -> u64

Retrieves the column number of the mark.

The column number indicates the column within the line where the mark is located.

Returns

Returns the column number of the mark as a u64.

Trait Implementations

impl Clone for Mark

fn clone(&self) -> Mark

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mark

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

Formats the mark for debugging purposes.

The mark is formatted as a debug struct with either the line and column numbers or the index, depending on their values.

Arguments

• formatter - The formatter to write the debug output to.

Returns

Returns Ok(()) if the formatting was successful, or an error otherwise.

impl Display for Mark

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

Formats the mark for display purposes.

If the line and column numbers are non-zero, the mark is formatted as “line X column Y”. Otherwise, the mark is formatted as “position Z”, where Z is the index.

Arguments

• formatter - The formatter to write the display output to.

Returns

Returns Ok(()) if the formatting was successful, or an error otherwise.

impl Copy for Mark