Struct MarkdownCommentContext 

pub struct MarkdownCommentContext {
    pub source_path: Option<String>,
    pub target_label: String,
    pub source_lines: MarkdownLineRange,
    pub source_excerpt: String,
    pub heading_path: Vec<String>,
    pub code_language: Option<String>,
}

Context retained with a Markdown comment so it remains useful when outdated.

Fields

source_path: Option<String>

target_label: String

source_lines: MarkdownLineRange

source_excerpt: String

heading_path: Vec<String>

The containing heading path at the time the comment was made.

code_language: Option<String>

The code language, when the target belongs to a fenced code block.

Implementations

impl MarkdownCommentContext

pub fn from_target( document: &MarkdownDocument, target: MarkdownTargetId, anchor: &MarkdownAnchor, ) -> Option<MarkdownCommentContext>

Captures the display and source context for a document target.

Trait Implementations

impl Clone for MarkdownCommentContext

fn clone(&self) -> MarkdownCommentContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownCommentContext

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MarkdownCommentContext

fn deserialize<__D>( __deserializer: __D, ) -> Result<MarkdownCommentContext, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarkdownCommentContext

impl PartialEq for MarkdownCommentContext

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MarkdownCommentContext

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarkdownCommentContext