Struct AlgorithmRef 

pub struct AlgorithmRef {
    pub target: String,
    pub line: Option<String>,
    pub format: Option<String>,
}

An algorithm reference mark for cross-referencing algorithms and their lines.

Used inline to reference algorithms or specific lines within algorithms.

Example JSON

{
  "type": "text",
  "value": "Algorithm 1",
  "marks": [
    {
      "type": "academic:algorithm-ref",
      "target": "#alg-quicksort",
      "format": "Algorithm {number}"
    }
  ]
}

Fields

target: String

Content Anchor URI to the algorithm (e.g., “#alg-quicksort”).

line: Option<String>

Optional line label for line-specific references.

format: Option<String>

Display format with placeholders (e.g., “Algorithm {number}” or “line {line}”).

Implementations

impl AlgorithmRef

pub fn new(target: impl Into<String>) -> Self

Create a new algorithm reference.

pub fn with_line(self, line: impl Into<String>) -> Self

Reference a specific line within the algorithm.

pub fn with_format(self, format: impl Into<String>) -> Self

Set a custom format string.

Use {number} for algorithm number, {line} for line reference.

pub fn to_extension_mark(&self) -> ExtensionMark

Convert to an extension mark for use in text.

Trait Implementations

impl Clone for AlgorithmRef

fn clone(&self) -> AlgorithmRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlgorithmRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AlgorithmRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AlgorithmRef

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

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 AlgorithmRef

impl StructuralPartialEq for AlgorithmRef