Properties

The CodeChunk type has these properties:

Name	Description	Type	Inherited from
`id`	The identifier for this item.	`String`	`Entity`
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`code`	The code.	`Cord`	`CodeExecutable`
`programmingLanguage`	The programming language of the code.	`String`	`CodeExecutable`
`executionBounds`	The environment in which code should be executed.	`ExecutionBounds`	`CodeExecutable`
`executionBounded`	The execution bounds, if any, on the last execution.	`ExecutionBounds`	`CodeExecutable`
`authors`	The authors of the executable code.	`Author`*	`CodeExecutable`
`provenance`	A summary of the provenance of the code.	`ProvenanceCount`*	`CodeExecutable`
`labelType`	The type of the label for the chunk.	`LabelType`	-
`label`	A short label for the chunk.	`String`	-
`labelAutomatically`	Whether the label should be automatically updated.	`Boolean`	-
`caption`	A caption for the chunk.	`Block`*	-
`outputs`	Outputs from executing the chunk.	`Node`*	-
`isEchoed`	Whether the code should be displayed to the reader.	`Boolean`	-
`isHidden`	Whether the outputs should be hidden from the reader.	`Boolean`	-
`executionPure`	Whether the code should be treated as side-effect free when executed.	`Boolean`	-

The CodeChunk type is related to these types:

Parents: CodeExecutable

Children: none

Bindings

The CodeChunk type is represented in:

JSON-LD

JSON Schema

Python class CodeChunk

Rust struct CodeChunk

TypeScript class CodeChunk

Testing

During property-based (a.k.a generative) testing, the properties of the CodeChunk type are generated using the following strategies.

Property	Complexity	Description	Strategy
`code`	Min+	Generate a simple fixed string of code.	`Cord::from("code")`
	Low+	Generate a random string of up to 10 alphanumeric characters (excludes whitespace whichcan be problematic in Markdown).	`r"[a-zA-Z0-9]{1,10}".prop_map(Cord::from)`
	High+	Generate a random string of up to 100 characters (excluding control characters).	`r"[^\p{C}]{1,100}".prop_map(Cord::from)`
	Max	Generate an arbitrary string.	`String::arbitrary().prop_map(Cord::from)`
`programmingLanguage`	Min+	Generate a simple fixed string.	`Some(String::from("lang"))`
	Low+	Generate one of the well known programming language short names.	`option::of(r"(cpp)\|(js)\|(py)\|(r)\|(ts)")`
	High+	Generate a random string of up to 10 alphanumeric characters.	`option::of(r"[a-zA-Z0-9]{1,10}")`
	Max	Generate an arbitrary string.	`option::of(String::arbitrary())`
`labelType`	Min+	No label type	`None`
	Low+	Generate either FigureLabel or TableLabel	`option::of(prop_oneof![Just(LabelType::FigureLabel), Just(LabelType::TableLabel)])`
`label`	Min+	No label	`None`
	Low+	Generate a simple label	`option::of(r"[a-zA-Z0-9]+")`
	Max	Generate an arbitrary string	`option::of(String::arbitrary())`
`caption`	Min+	No caption	`None`
	Low+	Generate up to two arbitrary paragraphs.	`option::of(vec_paragraphs(2))`

This documentation was generated from CodeChunk.yaml by docs_types.rs.

Properties

Related

Bindings

Testing