murex rocks

Welcome

About

Install

Change Log

Blog

Technical Docs

User Guide

Quick Start

Syntax

Commands

Types

Open Source

Go APIs

GitHub repo

Search Site

murex Shell Docs

API Reference

This section is a glossary of APIs.

These APIs are provided for reference for any developers wishing to write their own builtins. However some APIs are still worth being aware of even when just writing murex scripts because they provide a background into the internal logic of murex’s runtime.

Pages

• Marshal() (type): Converts structured memory into a structured file format (eg for stdio)
• ReadArray() (type): Read from a data type one array element at a time
• ReadArrayWithType() (type): Read from a data type one array element at a time and return the elements contents and data type
• ReadIndex() (type): Data type handler for the index, [, builtin
• ReadMap() (type): Treat data type as a key/value structure and read its contents
• ReadNotIndex() (type): Data type handler for the bang-prefixed index, ![, builtin
• Unmarshal() (type): Converts a structured file format into structured memory
• WriteArray() (type): Write a data type, one array element at a time
• lang.ArrayTemplate() (template API): Unmarshals a data type into a Go struct and returns the results as an array
• lang.ArrayWithTypeTemplate() (template API): Unmarshals a data type into a Go struct and returns the results as an array with data type included
• lang.IndexTemplateObject() (template API): Returns element(s) from a data structure
• lang.IndexTemplateTable() (template API): Returns element(s) from a table
• lang.MarshalData() (system API): Converts structured memory into a murex data-type (eg for stdio)
• lang.UnmarshalData() (system API): Converts a murex data-type into structured memory