Struct ExecutorSettings 

pub struct ExecutorSettings {
    pub highlight_edges: bool,
    pub enable_ssao: bool,
    pub show_grid: bool,
    pub replay: Option<String>,
    pub project_directory: Option<TypedPath>,
    pub current_file: Option<TypedPath>,
    pub fixed_size_grid: bool,
    pub skip_artifact_graph: bool,
    pub heartbeats: Option<u64>,
}

The executor settings.

Fields

highlight_edges: bool

Highlight edges of 3D objects?

enable_ssao: bool

Whether or not Screen Space Ambient Occlusion (SSAO) is enabled.

show_grid: bool

Show grid?

replay: Option<String>

Should engine store this for replay? If so, under what name?

project_directory: Option<TypedPath>

The directory of the current project. This is used for resolving import paths. If None is given, the current working directory is used.

current_file: Option<TypedPath>

This is the path to the current file being executed. We use this for preventing cyclic imports.

fixed_size_grid: bool

Whether or not to automatically scale the grid when user zooms.

skip_artifact_graph: bool

Skip sending the engine messages that are only needed to build the artifact graph. When this is true, the artifact graph will be incomplete. So you should only use this option if you know you don’t need the artifact graph or anything that depends on it. In that case, skipping these commands can make execution slightly faster.

heartbeats: Option<u64>

If Some(N), sends a heartbeat to keep the WebSocket active, every N seconds. If None, no heartbeats will be sent.

Implementations

impl ExecutorSettings

pub fn with_current_file(&mut self, current_file: TypedPath)

Add the current file path to the executor settings.

Trait Implementations

impl Clone for ExecutorSettings

fn clone(&self) -> ExecutorSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutorSettings

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

Formats the value using the given formatter.

impl Default for ExecutorSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecutorSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Configuration> for ExecutorSettings

fn from(config: Configuration) -> Self

Converts to this type from the input type.

impl From<ProjectConfiguration> for ExecutorSettings

fn from(config: ProjectConfiguration) -> Self

Converts to this type from the input type.

impl PartialEq for ExecutorSettings

fn eq(&self, other: &ExecutorSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ExecutorSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for ExecutorSettings

type WithoutGenerics = ExecutorSettings

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ExecutorSettings

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl StructuralPartialEq for ExecutorSettings