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

     1  # `*` (generic)
     2  
     3  > generic (primitive)
     4  
     5  ## Description
     6  
     7  This is the default data type used when STDOUT is returned from any external
     8  executables.
     9  
    10  ## Supported Hooks
    11  
    12  * `Marshal()`
    13      Supported. Tables columns are aligned
    14  * `ReadArray()`
    15      Treats each new line as a new array element
    16  * `ReadArrayWithType()`
    17      Treats each new line as a new array element, each element is `*` 
    18  * `ReadIndex()`
    19      Indexes treated as table coordinates
    20  * `ReadMap()`
    21      Works against tables such as the output from `ps -fe` 
    22  * `ReadNotIndex()`
    23      Indexes treated as table coordinates
    24  * `Unmarshal()`
    25      Supported
    26  * `WriteArray()`
    27      Writes a new line per array element - tabs are treated as columns
    28  
    29  ## See Also
    30  
    31  * [`[[ Element ]]`](../parser/element.md):
    32    Outputs an element from a nested structure
    33  * [`cast`](../commands/cast.md):
    34    Alters the data type of the previous function without altering it's output
    35  * [`format`](../commands/format.md):
    36    Reformat one data-type into another data-type
    37  * [`int`](../types/int.md):
    38    Whole number (primitive)
    39  * [`num` (number)](../types/num.md):
    40    Floating point number (primitive)
    41  * [`open`](../commands/open.md):
    42    Open a file with a preferred handler
    43  * [`runtime`](../commands/runtime.md):
    44    Returns runtime information on the internal state of Murex
    45  * [`str` (string)](../types/str.md):
    46    string (primitive)
    47  * [index](../parser/item-index.md):
    48    Outputs an element from an array, map or table
    49  
    50  ### Read more about type hooks
    51  
    52  - [`ReadIndex()` (type)](../apis/ReadIndex.md): Data type handler for the index, `[`, builtin
    53  - [`ReadNotIndex()` (type)](../apis/ReadNotIndex.md): Data type handler for the bang-prefixed index, `![`, builtin
    54  - [`ReadArray()` (type)](../apis/ReadArray.md): Read from a data type one array element at a time
    55  - [`WriteArray()` (type)](../apis/WriteArray.md): Write a data type, one array element at a time
    56  - [`ReadMap()` (type)](../apis/ReadMap.md): Treat data type as a key/value structure and read its contents
    57  - [`Marshal()` (type)](../apis/Marshal.md): Converts structured memory into a structured file format (eg for stdio)
    58  - [`Unmarshal()` (type)](../apis/Unmarshal.md): Converts a structured file format into structured memory
    59  
    60  <hr/>
    61  
    62  This document was generated from [builtins/types/generic/generic_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/types/generic/generic_doc.yaml).