Header menu logo Nu

Symbolics Module

Types

Type Description

Symbolics

Provides references to symbols that are loaded from files.

Functions and values

Function or value Description

Symbolics.makeEmpty ()

Full Usage: Symbolics.makeEmpty ()

Parameters:
    () : unit

Returns: Symbolics

Empty symbolics.

() : unit
Returns: Symbolics

Symbolics.reloadSymbols symbolics

Full Usage: Symbolics.reloadSymbols symbolics

Parameters:

Reload all the symbols in symbolics.

symbolics : Symbolics

Symbolics.tryGetSymbol assetTag metadata symbolics

Full Usage: Symbolics.tryGetSymbol assetTag metadata symbolics

Parameters:
Returns: Symbol option

Try to find a symbol with the given asset tag.

assetTag : Symbol AssetTag
metadata : SymbolLoadMetadata
symbolics : Symbolics
Returns: Symbol option

Symbolics.tryGetSymbols metadata assetTags symbolics

Full Usage: Symbolics.tryGetSymbols metadata assetTags symbolics

Parameters:
Returns: Symbol list

Try to find the symbols with the given asset tags.

metadata : Symbol AssetTag
assetTags : SymbolLoadMetadata list
symbolics : Symbolics
Returns: Symbol list

Symbolics.tryLoadSymbol assetTag metadata symbolics

Full Usage: Symbolics.tryLoadSymbol assetTag metadata symbolics

Parameters:
Returns: (SymbolLoadMetadata * Symbol) option

Attempt to load a symbol with the given asset tag.

assetTag : Symbol AssetTag
metadata : SymbolLoadMetadata
symbolics : Symbolics
Returns: (SymbolLoadMetadata * Symbol) option

Symbolics.tryLoadSymbolPackage packageName metadata symbolics

Full Usage: Symbolics.tryLoadSymbolPackage packageName metadata symbolics

Parameters:

Attempt to load a symbol package with the given name.

packageName : string
metadata : SymbolLoadMetadata
symbolics : Symbolics

Symbolics.unloadSymbolPackage packageName symbolics

Full Usage: Symbolics.unloadSymbolPackage packageName symbolics

Parameters:

Unload a symbol package with the given name.

packageName : string
symbolics : Symbolics

Type something to start searching.