github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/apis/README.md (about)

     1  # API Reference
     2  
     3  This section is a glossary of APIs.
     4  
     5  These APIs are provided for reference for any developers wishing to write
     6  their own builtins. However some APIs are still worth being aware of even
     7  when just writing Murex scripts because they provide a background into
     8  the internal logic of Murex's runtime.
     9  
    10  ## Pages
    11  
    12  * [`Marshal()` (type)](../apis/Marshal.md):
    13    Converts structured memory into a structured file format (eg for stdio)
    14  * [`ReadArray()` (type)](../apis/ReadArray.md):
    15    Read from a data type one array element at a time
    16  * [`ReadArrayWithType()` (type)](../apis/ReadArrayWithType.md):
    17    Read from a data type one array element at a time and return the elements contents and data type
    18  * [`ReadIndex()` (type)](../apis/ReadIndex.md):
    19    Data type handler for the index, `[`, builtin
    20  * [`ReadMap()` (type)](../apis/ReadMap.md):
    21    Treat data type as a key/value structure and read its contents
    22  * [`ReadNotIndex()` (type)](../apis/ReadNotIndex.md):
    23    Data type handler for the bang-prefixed index, `![`, builtin
    24  * [`Unmarshal()` (type)](../apis/Unmarshal.md):
    25    Converts a structured file format into structured memory
    26  * [`WriteArray()` (type)](../apis/WriteArray.md):
    27    Write a data type, one array element at a time
    28  * [`lang.ArrayTemplate()` (template API)](../apis/lang.ArrayTemplate.md):
    29    Unmarshals a data type into a Go struct and returns the results as an array
    30  * [`lang.ArrayWithTypeTemplate()` (template API)](../apis/lang.ArrayWithTypeTemplate.md):
    31    Unmarshals a data type into a Go struct and returns the results as an array with data type included
    32  * [`lang.IndexTemplateObject()` (template API)](../apis/lang.IndexTemplateObject.md):
    33    Returns element(s) from a data structure
    34  * [`lang.IndexTemplateTable()` (template API)](../apis/lang.IndexTemplateTable.md):
    35    Returns element(s) from a table
    36  * [`lang.MarshalData()` (system API)](../apis/lang.MarshalData.md):
    37    Converts structured memory into a Murex data-type (eg for stdio)
    38  * [`lang.UnmarshalData()` (system API)](../apis/lang.UnmarshalData.md):
    39    Converts a Murex data-type into structured memory