Struct stencila_schema::CodeChunk[−][src]

pub struct CodeChunk {
Show fields
    pub type_: String,
    pub text: String,
    pub alters: Option<Vec<String>>,
    pub assigns: Option<Vec<CodeChunkAssigns>>,
    pub caption: Option<CodeChunkCaption>,
    pub declares: Option<Vec<CodeChunkDeclares>>,
    pub duration: Option<f32>,
    pub errors: Option<Vec<CodeError>>,
    pub export_from: Option<String>,
    pub format: Option<String>,
    pub id: Option<String>,
    pub import_to: Option<String>,
    pub imports: Option<Vec<CodeChunkImports>>,
    pub label: Option<String>,
    pub meta: Option<HashMap<String, Value>>,
    pub outputs: Option<Vec<Node>>,
    pub programming_language: Option<String>,
    pub reads: Option<Vec<String>>,
    pub uses: Option<Vec<CodeChunkUses>>,

}
Expand description

A executable chunk of code.

Fields

type_: String

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

A caption for the CodeChunk.

declares: Option<Vec<CodeChunkDeclares>>

Variables that the code chunk declares.

duration: Option<f32>

Duration in seconds of the last execution of the chunk.

errors: Option<Vec<CodeError>>

Errors when compiling or executing the chunk.

export_from: Option<String>

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

format: Option<String>

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

id: Option<String>

The identifier for this item.

import_to: Option<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<String>

A short label for the CodeChunk.

meta: Option<HashMap<String, Value>>

Metadata associated with this item.

outputs: Option<Vec<Node>>

Outputs from executing the chunk.

programming_language: Option<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).

Implementations

impl CodeChunk[src]

pub fn deserialize_type<'de, D>(d: D) -> Result<String, D::Error> where
    D: Deserializer<'de>, [src]

Trait Implementations

impl Clone for CodeChunk[src]

fn clone(&self) -> CodeChunk[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for CodeChunk[src]

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

Formats the value using the given formatter. Read more

impl Default for CodeChunk[src]

fn default() -> Self[src]

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

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

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

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for CodeChunk[src]

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

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

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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