Home

Include Block

This type is marked as unstable and is subject to change.

Properties

The IncludeBlock type has these properties:

NameDescriptionTypeInherited from
idThe identifier for this item.StringEntity
executionModeUnder which circumstances the node should be executed.ExecutionModeExecutable
compilationDigestA digest of the content, semantics and dependencies of the node.CompilationDigestExecutable
compilationMessagesMessages generated while compiling the code.CompilationMessage*Executable
executionDigestThe compilationDigest of the node when it was last executed.CompilationDigestExecutable
executionDependenciesThe upstream dependencies of this node.ExecutionDependency*Executable
executionDependantsThe downstream dependants of this node.ExecutionDependant*Executable
executionTagsTags in the code which affect its execution.ExecutionTag*Executable
executionCountA count of the number of times that the node has been executed.IntegerExecutable
executionRequiredWhether, and why, the code requires execution or re-execution.ExecutionRequiredExecutable
executionStatusStatus of the most recent, including any current, execution.ExecutionStatusExecutable
executionInstanceThe id of the kernel instance that performed the last execution.StringExecutable
executionEndedThe timestamp when the last execution ended.TimestampExecutable
executionDurationDuration of the last execution.DurationExecutable
executionMessagesMessages emitted while executing the node.ExecutionMessage*Executable
sourceThe external source of the content, a file path or URL.String-
mediaTypeMedia type of the source content.String-
selectA query to select a subset of content from the sourceString-
contentThe structured content decoded from the source.Block*-

Related

The IncludeBlock type is related to these types:

Bindings

The IncludeBlock type is represented in:

Testing

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

PropertyComplexityDescriptionStrategy
sourceMin+Generate a fixed path.String::from("path/to/source.file")
Low+Generate a random string with up to 30 alphanumeric characters, forward slashes,hyphens, and dots (exclude characters in such as underscores an asterisks whichhave semantic meaning in Markdown).Regex [a-zA-Z0-9/\-.]{1,30}
High+Generate a random string of up to 100 characters (excluding control characters).Regex [^\p{C}]{1,100}
MaxGenerate an arbitrary string.String::arbitrary()

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

© 2026 Stencila