Struct CalloutRef 

pub struct CalloutRef {
    pub kind: CalloutRefKind,
    pub number: usize,
    pub location: Location,
}

A CalloutRef represents a callout reference marker within verbatim content.

Callout references appear at the end of lines in source/listing blocks and link to explanatory text in a subsequent callout list.

Examples

[source,ruby]
----
def main <1>
  puts 'hello' <.>
end
----
<1> Defines the main function
<.> Prints a greeting

The <1> marker creates an Explicit callout ref, while <.> creates an Auto callout ref that gets resolved to the next available number.

Fields

kind: CalloutRefKind

The kind of callout (explicit number vs auto-numbered).

number: usize

The resolved callout number (1-indexed).

location: Location

Source location of this callout reference.

Implementations

impl CalloutRef

pub fn explicit(number: usize, location: Location) -> Self

Creates a new explicit callout reference with the given number.

pub fn auto(number: usize, location: Location) -> Self

Creates a new auto-numbered callout reference with the resolved number.

Trait Implementations

impl Clone for CalloutRef

fn clone(&self) -> CalloutRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CalloutRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CalloutRef

fn deserialize<D>(deserializer: D) -> Result<CalloutRef, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CalloutRef

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CalloutRef

impl StructuralPartialEq for CalloutRef