File: lyaml.h

package info (click to toggle)
tarantool 2.6.0-1.4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 85,412 kB
  • sloc: ansic: 513,775; cpp: 69,493; sh: 25,650; python: 19,190; perl: 14,973; makefile: 4,178; yacc: 1,329; sql: 1,074; pascal: 620; ruby: 190; awk: 18; lisp: 7
file content (46 lines) | stat: -rw-r--r-- 1,259 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
#ifndef LYAML_H
#define LYAML_H

#ifdef __cplusplus
extern "C" {
#endif

#include <lua.h>

struct luaL_serializer;

LUALIB_API int
luaopen_yaml(lua_State *L);

/** @Sa luaL_newserializer(). */
struct luaL_serializer *
lua_yaml_new_serializer(lua_State *L);

/**
 * Encode an object on Lua stack into YAML stream.
 * @param L Lua stack to get an argument and push the result.
 * @param serializer Lua YAML serializer.
 * @param tag_handle NULL, or a global tag handle. For global tags
 *        details see the standard:
 *        http://yaml.org/spec/1.2/spec.html#tag/shorthand/.
 * @param tag_prefix NULL, or a global tag prefix, to which @a
 *        handle is expanded. Example of a tagged document:
 *              handle          prefix
 *               ____   ________________________
 *              /    \ /                        \
 *        '%TAG !push! tag:tarantool.io/push,2018
 *         --- value
 *         ...
 *
 * @retval 2 Pushes two values on error: nil, error description.
 * @retval 1 Pushes one value on success: string with dumped
 *         object.
 */
int
lua_yaml_encode(lua_State *L, struct luaL_serializer *serializer,
		const char *tag_handle, const char *tag_prefix);

#ifdef __cplusplus
}
#endif
#endif /* #ifndef LYAML_H */