Struct stencila_schema::CodeChunk

pub struct CodeChunk {

    pub type_: CodeChunk_,
    pub text: String,
    pub alters: Option<Vec<String>>,
    pub assigns: Option<Vec<CodeChunkAssigns>>,
    pub caption: Option<Box<CodeChunkCaption>>,
    pub declares: Option<Vec<CodeChunkDeclares>>,
    pub duration: Option<Box<f64>>,
    pub errors: Option<Vec<CodeError>>,
    pub export_from: Option<Box<String>>,
    pub format: Option<Box<String>>,
    pub id: Option<Box<String>>,
    pub import_to: Option<Box<String>>,
    pub imports: Option<Vec<CodeChunkImports>>,
    pub label: Option<Box<String>>,
    pub outputs: Option<Vec<Node>>,
    pub programming_language: Option<Box<String>>,
    pub reads: Option<Vec<String>>,
    pub uses: Option<Vec<CodeChunkUses>>,
}

A executable chunk of code.

Fields

type_: CodeChunk_

The name of this type

text: String

The text of the code.

alters: Option<Vec<String>>

Names of variables that the code chunk alters.

assigns: Option<Vec<CodeChunkAssigns>>

Variables that the code chunk assigns to.

caption: Option<Box<CodeChunkCaption>>

A caption for the CodeChunk.

declares: Option<Vec<CodeChunkDeclares>>

Variables that the code chunk declares.

duration: Option<Box<f64>>

Duration in seconds of the last execution of the chunk.

errors: Option<Vec<CodeError>>

Errors when compiling or executing the chunk.

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.

imports: Option<Vec<CodeChunkImports>>

Software packages that the code chunk imports

label: Option<Box<String>>

A short label for the CodeChunk.

outputs: Option<Vec<Node>>

Outputs from executing the chunk.

programming_language: Option<Box<String>>

The programming language of the code.

reads: Option<Vec<String>>

Filesystem paths that this code chunk reads from.

uses: Option<Vec<CodeChunkUses>>

Names of variables that the code chunk uses (but does not alter).

Trait Implementations

impl Clone for CodeChunk

fn clone(&self) -> CodeChunk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeChunk

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

Formats the value using the given formatter.

impl Default for CodeChunk

fn default() -> Self

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl From<CodeChunk> for BlockContent

fn from(v: CodeChunk) -> BlockContent

Performs the conversion.

impl From<CodeChunk> for CodeBlockTypes

fn from(v: CodeChunk) -> CodeBlockTypes

Performs the conversion.

impl From<CodeChunk> for CodeTypes

fn from(v: CodeChunk) -> CodeTypes

Performs the conversion.

impl From<CodeChunk> for EntityTypes

fn from(v: CodeChunk) -> EntityTypes

Performs the conversion.

impl NodeTrait for CodeChunk

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 CodeChunk

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

Serialize this value into the given Serde serializer.

impl TryInto<CodeChunk> for BlockContent

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<CodeChunk> for CodeBlockTypes

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<CodeChunk> for CodeTypes

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryInto<CodeChunk> for EntityTypes

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.