Librairie Lua `yaml`

La librairie yaml permet de manipuler des données au format YAML.

Import

Pour importer la librairie en Lua :

local yaml = require("yaml")

Configuration YAML

La librairie yaml est disponible par défaut et ne nécessite aucune configuration dans le fichier YAML de l'agent.

API Lua

Liste des fonctions

Fonction	Signature Lua	Rôle	Retour (succès)	Retour (échec)
`encode`	`str, err = yaml.encode(data)`	Encode des données Lua en YAML.	`string, nil`	`nil, "msg"`
`decode`	`data, err = yaml.decode(yamlString)`	Décode une chaîne YAML en Lua.	`table, nil`	`nil, "msg"`

`yaml.encode(data)`

Encode des données Lua en chaîne YAML.

Paramètres :
data (table) : Les données Lua à encoder.
Retour :
Une chaîne YAML représentant les données Lua.
nil et un message d'erreur en cas d'échec.

local yaml = require("yaml")

local data = {
    name = "Alemca",
    version = 1.0,
    features = { "iot", "remote", "metrics" }
}
local yamlString, err = yaml.encode(data)
if err then
    print("Erreur lors de l'encodage YAML : " .. err)
else
    print("Chaîne YAML :\n" .. yamlString)
end

`yaml.decode(yamlString)`

Décode une chaîne YAML en données Lua.

Paramètres :
yamlString (string) : La chaîne YAML à décoder.
Retour :
Une table Lua représentant les données YAML.
nil et un message d'erreur en cas d'échec.

local yaml = require("yaml")

local yamlString = [[
name: Alemca
version: 1.0
features:
  - iot
  - remote
  - metrics
]]

local data, err = yaml.decode(yamlString)
if err then
    print("Erreur lors du décodage YAML : " .. err)
else
    print("Nom : " .. data.name .. ", Version : " .. data.version)
end

Champs Lua associés

Cette librairie est un utilitaire et ne possède pas de champs name ou type.

Librairie Lua yaml