Marshal()
(type)Converts structured memory into a structured file format (eg for stdio)
This is a function you would write when programming a murex data-type. The marshal function takes in a Go (golang) type
or struct
and returns a byte slice of a "string" representation of that format (eg in JSON) or an error.
This marshaller is then registered to murex inside an init()
function and murex builtins can use that marshaller via the MarshalData()
API.
Registering Marshal()
(for writing builtin data-types)
// To avoid data races, this should only happen inside func init()
lang.Marshallers[ /* your type name */ ] = /* your readIndex func */
Using an existing marshaller (eg inside a builtin command)
// See documentation on lang.MarshalData for more details
b, err := lang.MarshalData(p, dataType, data)
Defining a marshaller for a murex data-type
package example
import (
"encoding/json"
"github.com/lmorg/murex/lang"
)
func init() {
// Register data-type
lang.Marshallers["json"] = marshal
}
// Describe marshaller
func marshal(p *lang.Process, v interface{}) ([]byte, error) {
if p.Stdout.IsTTY() {
// If STDOUT is a TTY (ie not pipe, text file or other destination other
// than a terminal) then output JSON in an indented, human readable,
// format....
return json.MarshalIndent(v, "", " ")
}
// ....otherwise we might as well output it in a minified format
return json.Marshal(v)
}
*lang.Process
: Process's runtime state. Typically expressed as the variable p
interface{}
: data you wish to marshalUnmarshal()
(type): Converts a structured file format into structured memorylang.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 memoryThis 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 Thu May 26 22:49:43 UTC 2022 against commit 59e27bb59e27bb1013043fc4a940cf9a2767c63f31dad2c.
Current version is 2.8.2100 which has been verified against 15889 tests cases.