Zen

Source string Source string

410/10000 · 410
English Actions
return
the original value reformatted as a YAML string.
rtype
string
Convert a YAML string to a Lua object.
a string formatted as YAML.
the original contents formatted as a Lua table.
table
**__serialize parameter:**
The YAML output structure can be specified with ``__serialize``:
``'seq'``, ``'sequence'``, ``'array'``: table encoded as an array
``'map'``, ``'mapping'``: table encoded as a map
``function``: the meta-method called to unpack serializable representation of table, cdata, or userdata objects
``'seq'`` or ``'map'`` also enable the flow (compact) mode for the YAML serializer (``flow="[1,2,3]"`` vs ``block=" - 1\n - 2\n - 3\n"``).
Serializing ``'A'`` and ``'B'`` with different ``__serialize`` values brings different results:
tarantool> yaml.encode(setmetatable({'A', 'B'}, { __serialize="seq"}))
---
- '["A","B"]'
...
tarantool> yaml.encode(setmetatable({'A', 'B'}, { __serialize="map"}))
---
- '{"1":"A","2":"B"}'
...
tarantool> yaml.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="map"})})
---
- '[{"f2":"B","f1":"A"}]'
...
tarantool> yaml.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="seq"})})
---
- '[[]]'
...
Set values affecting the behavior of encode and decode functions.
The values are all either integers or boolean ``true``/``false``.
Option
Default
``cfg.encode_invalid_numbers``
true
A flag saying whether to enable encoding of NaN and Inf numbers
``cfg.encode_number_precision``
14
Precision of floating point numbers
``cfg.encode_load_metatables``
A flag saying whether the serializer will follow :ref:`__serialize <json-serialize>` metatable field
``cfg.encode_use_tostring``
false
A flag saying whether to use ``tostring()`` for unknown types

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/yaml — English

tarantool> yaml.encode(setmetatable({'A', 'B'}, { __serialize="seq"}))
---
- '["A","B"]'
...
tarantool> yaml.encode(setmetatable({'A', 'B'}, { __serialize="map"}))
---
- '{"1":"A","2":"B"}'
...
tarantool> yaml.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="map"})})
---
- '[{"f2":"B","f1":"A"}]'
...
tarantool> yaml.encode({setmetatable({f1 = 'A', f2 = 'B'}, { __serialize="seq"})})
---
- '[[]]'
...
2 years ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
2 years ago
Last updated
2 years ago
Source string age
2 years ago
Translation file
string 36