Struct CodeChunk

pub struct CodeChunk {

    pub type_: CodeChunk_,
    pub programming_language: String,
    pub text: String,
    pub caption: Option<Box<CodeChunkCaption>>,
    pub code_dependencies: Option<Vec<CodeExecutableCodeDependencies>>,
    pub code_dependents: Option<Vec<CodeExecutableCodeDependents>>,
    pub compile_digest: Option<Box<Cord>>,
    pub errors: Option<Vec<CodeError>>,
    pub execute_auto: Option<CodeChunkExecuteAuto>,
    pub execute_count: Option<u32>,
    pub execute_digest: Option<Box<Cord>>,
    pub execute_duration: Option<Number>,
    pub execute_ended: Option<Box<Date>>,
    pub execute_pure: Option<Boolean>,
    pub execute_required: Option<CodeExecutableExecuteRequired>,
    pub execute_status: Option<CodeExecutableExecuteStatus>,
    pub id: Option<Box<String>>,
    pub label: Option<Box<String>>,
    pub media_type: Option<Box<String>>,
    pub outputs: Option<Vec<Node>>,
}

A executable chunk of code.

Fields

type_: CodeChunk_

The name of this type

programming_language: String

The programming language of the code.

text: String

The text of the code.

caption: Option<Box<CodeChunkCaption>>

A caption for the CodeChunk.

code_dependencies: Option<Vec<CodeExecutableCodeDependencies>>

The upstream dependencies of the code.

code_dependents: Option<Vec<CodeExecutableCodeDependents>>

The downstream dependents of the code.

compile_digest: Option<Box<Cord>>

A digest of the content, semantics and dependencies of the node.

errors: Option<Vec<CodeError>>

Errors when compiling (e.g. syntax errors) or executing the chunk.

execute_auto: Option<CodeChunkExecuteAuto>

Under which circumstances the node should be automatically executed.

execute_count: Option<u32>

A count of the number of times that the node has been executed.

execute_digest: Option<Box<Cord>>

The compileDigest of the node when it was last executed.

execute_duration: Option<Number>

Duration in seconds of the last execution of the code.

execute_ended: Option<Box<Date>>

The date-time that the the last execution of the code ended.

execute_pure: Option<Boolean>

Whether the code should be treated as side-effect free when executed.

execute_required: Option<CodeExecutableExecuteRequired>

Whether, and why, a node requires execution or re-execution.

execute_status: Option<CodeExecutableExecuteStatus>

Status of the most recent, including any current, execution of the code.

id: Option<Box<String>>

The identifier for this item.

label: Option<Box<String>>

A short label for the CodeChunk.

media_type: Option<Box<String>>

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

outputs: Option<Vec<Node>>

Outputs from executing the chunk.

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 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.