magmalake json_mlake

json_mlake · API

json.serialize

Traits

Serializable

Trait for types that can be serialized to JSON.

Implement this trait to enable automatic serialization with serialize().

Example: struct Person(Serializable): var name: String var age: Int

    def to_json(self) -> String:
        return '{"name":' + to_json_value(self.name) +
               ',"age":' + to_json_value(self.age) + '}'

var json = serialize(Person("Alice", 30))  # {"name":"Alice","age":30}

to_json

def to_json(self) -> String

Serialize this object to a JSON string.

Functions

to_string

def to_string(v: Value) -> String

Convert a Value to a JSON string (compact).

dumps

def dumps(v: Value, indent: String = "") -> String

Serialize a Value to JSON string (like Python's json.dumps).

Example: var data = loads('{"name": "Alice", "age": 30}') print(dumps(data)) # {"name":"Alice","age":30}. print(dumps(data, indent=" ")) # Pretty-printed.

Args
v: Value to serialize.
indent: Indentation string (empty for compact, e.g., " " for 2 spaces).
def dumps(v: Value, config: SerializerConfig) -> String

Serialize a Value with custom configuration.

Every option is honoured by the writer during the one structural walk. They used to be applied afterwards by re-scanning the finished text: sort_keys was a function that returned its input unchanged, and the two escaping options rebuilt the string through chr per byte, so any character above U+007F came out as the Latin-1 reading of its UTF-8 bytes.

Example: var json = dumps(value, SerializerConfig(indent=" ", escape_unicode=True)).

Args
v: Value to serialize.
config: Serializer configuration.
def dumps[format: StringSpan[ImmStaticOrigin] = StringSpan("json")](values: List[Value]) -> String

Serialize a list of Values to NDJSON string.

Example: var values = ListValue values.append(loads('{"a":1}')) values.append(loads('{"a":2}')) print(dumpsformat="ndjson").

Parameters
format: Must be "ndjson" for this overload.
Args
values: List of Values to serialize.
def dumps[format: StringSpan[ImmStaticOrigin] = StringSpan("json")](values: List[Value], config: SerializerConfig) -> String

Serialize a list of Values to NDJSON with custom configuration.

The indent option is ignored here: NDJSON puts one value per line, so a value spread over several lines would not be readable back.

Parameters
format: Must be "ndjson" for this overload.
Args
values: List of Values to serialize.
config: Serializer configuration.

dump

def dump(v: Value, mut f: FileHandle)

Serialize a Value and write to file (like Python's json.dump).

Example: with open("output.json", "w") as f: dump(data, f).

Args
v: Value to serialize.
f: FileHandle to write JSON to.
def dump(v: Value, mut f: FileHandle, indent: String)

Serialize a Value with indentation and write to file.

Example: with open("output.json", "w") as f: dump(data, f, indent=" ").

Args
v: Value to serialize.
f: FileHandle to write JSON to.
indent: Indentation string.
def dump(v: Value, mut f: FileHandle, config: SerializerConfig)

Serialize a Value with custom configuration and write to file.

Example: with open("output.json", "w") as f: dump(data, f, SerializerConfig(indent=" ", sort_keys=True)).

Args
v: Value to serialize.
f: FileHandle to write JSON to.
config: Serializer configuration.
def dump[format: StringSpan[ImmStaticOrigin] = StringSpan("json")](values: List[Value], mut f: FileHandle)

Serialize a list of Values to NDJSON and write to file.

Example: with open("output.ndjson", "w") as f: dump[format="ndjson"](values, f).

Parameters
format: Must be "ndjson" for this overload.
Args
values: List of Values to serialize.
f: FileHandle to write NDJSON to.

to_json_string

def to_json_string(s: String) -> String

Convert a String to JSON string format (with quotes and escaping).

to_json_value

def to_json_value(val: String) -> String

Convert String to JSON.

def to_json_value(val: Int) -> String

Convert Int to JSON.

def to_json_value(val: Int64) -> String

Convert Int64 to JSON.

def to_json_value(val: Float64) -> String

Convert Float64 to JSON.

def to_json_value(val: Bool) -> String

Convert Bool to JSON.

serialize

def serialize[T: Serializable](obj: T) -> String

Serialize an object to JSON string.

The object must implement the Serializable trait with a to_json() method.

Example: var person = Person("Alice", 30) var json = serialize(person) # {"name":"Alice","age":30}.

Parameters
T: Type that implements Serializable.
Args
obj: Object to serialize.