Struct stencila_schema::CodeChunk

source · [−]

pub struct CodeChunk {Show 20 fields
    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>>,
}

Expand description

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

source

impl Clone for CodeChunk

source

fn clone(&self) -> CodeChunk

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for CodeChunk

source

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

Formats the value using the given formatter. Read more

source

impl Default for CodeChunk

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

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

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl Serialize for CodeChunk

source

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for CodeChunk

impl Send for CodeChunk

impl Sync for CodeChunk

impl Unpin for CodeChunk

impl UnwindSafe for CodeChunk

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct stencila_schema::CodeChunk

Fields

Trait Implementations

impl Clone for CodeChunk

fn clone(&self) -> CodeChunk

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

impl Debug for CodeChunk

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

impl Default for CodeChunk

fn default() -> Self

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

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

impl Serialize for CodeChunk

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

Auto Trait Implementations

impl RefUnwindSafe for CodeChunk

impl Send for CodeChunk

impl Sync for CodeChunk

impl Unpin for CodeChunk

impl UnwindSafe for CodeChunk

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,