Struct somedoc::model::block::CodeBlock

pub struct CodeBlock { /* fields omitted */ }

A block of code, syntax highlighting may be used, especially if language is specified.

Implementations

impl CodeBlock

pub fn with_language(code: &str, language: &str) -> Self

Construct a new code block from the provided string ands language name.

pub fn code(&self) -> &String

Return the inner code value as a string.

pub fn set_code(&mut self, code: &str) -> &mut Self

Set the code value for this block.

pub fn language(&self) -> &Option<String>

Return the inner language name as a string, if present.

pub fn set_language(&mut self, language: &str) -> &mut Self

Set the language for this code block.

pub fn unset_language(&mut self) -> &mut Self

Set the language for this code block to None.

Trait Implementations

impl Clone for CodeBlock

fn clone(&self) -> CodeBlock

Returns a copy of the value.

pub 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<'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 From<&'_ str> for CodeBlock

fn from(code: &str) -> Self

Performs the conversion.

impl From<String> for CodeBlock

fn from(code: String) -> Self

Performs the conversion.

impl HasCaption for CodeBlock

fn caption(&self) -> &Option<Caption>

Return the caption, if present.

fn set_caption(&mut self, caption: Caption) -> &mut Self

Set the caption to the provided value.

fn unset_caption(&mut self) -> &mut Self

Set the caption to None.

fn has_caption(&self) -> bool

Returns true if a caption is set, else false.

impl HasLabel for CodeBlock

fn has_label(&self) -> bool

Returns true if this element has a label, else false.

fn label(&self) -> &Option<Label>

Return the element's label, if present.

fn set_label(&mut self, label: Label) -> &mut Self

Set the current element's label value.

fn unset_label(&mut self) -> &mut Self

Set the current element's label to None.

impl Into<BlockContent> for CodeBlock

fn into(self) -> BlockContent

Performs the conversion.

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.