murex Shell Docs

API Reference: Unmarshal() (type)

Converts a structured file format into structured memory


This is a function you would write when programming a murex data-type. The unmarshal function takes in a byte slice and returns a Go (golang) type or struct or an error.

This unmarshaller is then registered to murex inside an init() function and murex builtins can use that unmarshaller via the UnmarshalData() API.


Registering Unmarshal() (for writing builtin data-types)

// To avoid data races, this should only happen inside func init()
lang.Unmarshallers[ /* your type name */ ] = /* your readIndex func */

Using an existing unmarshaller (eg inside a builtin command)

// See documentation on lang.UnmarshalData for more details
v, err := lang.UnmarshalData(p *lang.Process, dataType string)


Defining a marshaller for a murex data-type

package example

import (


func init() {
    // Register data-type
    lang.Unmarshallers["example"] = unmarshal

// Describe unmarshaller
func unmarshal(p *lang.Process) (interface{}, error) {
    // Read data from STDIN. Because JSON expects closing tokens, we should
    // read the entire stream before unmarshalling it. For formats like CSV or
    // jsonlines which are more line based, we might want to read STDIN line by
    // line. However given there is just one data return, you still effectively
    // head to read the entire file before returning the structure. There are
    // other APIs for iterative returns for streaming data - more akin to the
    // traditional way UNIX pipes would work.
    b, err := p.Stdin.ReadAll()
    if err != nil {
        return nil, err

    var v interface{}
    err = json.Unmarshal(b, &v)

    // Return the Go data structure or error
    return v, err


  1. *lang.Process: Process's runtime state. Typically expressed as the variable p

See Also

This site's content is rebuilt automatically from murex's source code after each merge to the master branch. Downloadable murex binaries are also built with the website.

Last built on Wed Jan 12 10:38:51 UTC 2022 against commit 50d6f4550d6f45b79e200b3cbc8e8e2639854a5265c7021.

Current version is 2.4.3010 BETA which has been verified against tests.