Struct stencila_schema::CodeBlock

pub struct CodeBlock {
    pub type_: CodeBlock_,
    pub text: String,
    pub export_from: Option<Box<String>>,
    pub format: Option<Box<String>>,
    pub id: Option<Box<String>>,
    pub import_to: Option<Box<String>>,
    pub programming_language: Option<Box<String>>,
}

A code block.

Fields

type_: CodeBlock_

The name of this type

text: String

The text of the code.

export_from: Option<Box<String>>

A compilation directive giving the name of the variable to export into the content of the code block.

format: Option<Box<String>>

Media type, typically expressed using a MIME format, of the code.

id: Option<Box<String>>

The identifier for this item.

import_to: Option<Box<String>>

A compilation directive giving the name of the variable to import the content of the code block as.

programming_language: Option<Box<String>>

The programming language of the code.

Trait Implementations

impl Clone for CodeBlock

fn clone(&self) -> CodeBlock

Returns a copy 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 Default for CodeBlock

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeBlock where
    CodeBlock: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<CodeBlock> for BlockContent

fn from(v: CodeBlock) -> BlockContent

Performs the conversion.

impl From<CodeBlock> for CodeBlockTypes

fn from(v: CodeBlock) -> CodeBlockTypes

Performs the conversion.

impl From<CodeBlock> for CodeTypes

fn from(v: CodeBlock) -> CodeTypes

Performs the conversion.

impl From<CodeBlock> for EntityTypes

fn from(v: CodeBlock) -> EntityTypes

Performs the conversion.

impl NodeTrait for CodeBlock

fn type_name(&self) -> String

Retrieve the type of an entity Needs to be called type_name because type is a reserved word

fn id(&self) -> Option<String>

Retrieve the id of an entity

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.

impl TryInto<CodeBlock> for BlockContent

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CodeBlock, <Self as TryInto<CodeBlock>>::Error>

Performs the conversion.

impl TryInto<CodeBlock> for CodeBlockTypes

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CodeBlock, <Self as TryInto<CodeBlock>>::Error>

Performs the conversion.

impl TryInto<CodeBlock> for CodeTypes

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CodeBlock, <Self as TryInto<CodeBlock>>::Error>

Performs the conversion.

impl TryInto<CodeBlock> for EntityTypes

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CodeBlock, <Self as TryInto<CodeBlock>>::Error>

Performs the conversion.