Struct CodeBlock

pub struct CodeBlock {
    pub line_number: usize,
    pub indent: String,
    pub name: Option<String>,
    pub is_unnamed: bool,
    pub language: Option<String>,
    pub is_hidden: bool,
    pub is_file: bool,
    pub is_alternative: bool,
    pub source: Vec<Line>,
    pub source_file: Option<String>,
}

A CodeBlock is a block of code as defined by the input format.

Fields

line_number: usize

Source line number of the first code line

indent: String

The indent of this code block is in the documentation file

name: Option<String>

The name of this code block

is_unnamed: bool

Whether the code block was originally unnamed

language: Option<String>

The language this block was written in

is_hidden: bool

Marks the code block as hidden from docs

is_file: bool

Marks the code block as a file-based entrypoint

is_alternative: bool

Marks the code block as fenced by alternative sequence

source: Vec<Line>

The source is the lines of code

source_file: Option<String>

Source file, for transcluded blocks

Implementations

impl CodeBlock

pub fn new( line_number: usize, indent: String, language: Option<String>, alternative: bool, ) -> Self

Trait Implementations

impl Debug for CodeBlock

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

Formats the value using the given formatter.

impl Default for CodeBlock

fn default() -> CodeBlock

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CodeBlock

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

where __S: Serializer,

Serialize this value into the given Serde serializer.