Struct CodeBlock 

pub struct CodeBlock {
    pub kind: CodeBlockKind<'static>,
    pub language: Option<String>,
    pub info_string: String,
    pub attributes: Option<String>,
    pub source: String,
    pub byte_range: Range<usize>,
    pub line_range: Range<usize>,
    pub indent: usize,
}

A code block extracted from a Markdown document.

Fields

kind: CodeBlockKind<'static>

The code block kind.

language: Option<String>

First word from the fenced code block info string.

This is None for indented code blocks and for fenced code blocks without an info string.

info_string: String

Complete fenced code block info string, without the opening backticks.

This is empty for indented code blocks.

attributes: Option<String>

Remaining info string words after the language, if present.

source: String

Code block body.

byte_range: Range<usize>

Byte range covering the opening marker, body, and closing marker.

line_range: Range<usize>

Zero-based line range covering the opening marker, body, and closing marker.

indent: usize

Whitespace indentation before the opening marker.

Implementations

impl CodeBlock

pub fn is_fenced(&self) -> bool

Returns true for fenced code blocks.

pub fn has_info_word(&self, word: &str) -> bool

Returns true when the full info string contains word as a whitespace-separated token.

pub fn attributes(&self) -> impl Iterator<Item = &str>

Returns fenced code block attributes as whitespace-separated tokens.

For ```rust a b c, this yields a, b, and c.

pub fn has_attribute(&self, attribute: &str) -> bool

Returns true when the fenced code block attributes contain attribute.

Trait Implementations

impl Clone for CodeBlock

fn clone(&self) -> CodeBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeBlock

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

Formats the value using the given formatter.

impl PartialEq for CodeBlock

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