pluie-yaml-0.5

---

Description:

Pluie-Yaml is a vala shared library managing yaml files and yaml nodes.
As json is now a valid subset of yaml, Pluie-Yaml is also able to load json files
The lib partially manage tag directives and tag values.

• Official repository : https://gitea.meta-tech.academy/meta-tech/pluie-yaml
• Current version : 0.53

Content:

Namespaces:

• Pluie - root namespace of various Pluie lib
• Io - Pluie.Io is dedicated to various input/ouput operations

Classes:

• InputChunkStream - basic class to read file by chunk
• Reader - a class to read file line by line with convenient methods to rewind to specific lines using Io.StreamLineMark
• StreamLineMark - a class representing a stream mark recording a line and it's position in the stream to permit future rewind @see Io.Reader
• Writter - basic writter class
• Yaml - Pluie.Yaml provides various tools to deal with yaml files and yaml nodes :

Interfaces:

• Collection - interface representing a collection node

Classes:

• AbstractChild - abstract class representing a child node
• AbstractNode - abstract class representing a node
• Builder - a Yaml.Builder class helping to build vala Yaml.Object from Yaml.Node
• Config - Yaml.Config class to manage Yaml configuration files and provide a Yaml.Root node.
  Yaml.Config use a Yaml.Finder to easily retriew a particular node.
  The Yaml.Config.get method is bind to the Yaml.Finder.find method with
  the root node as context. (more details on Yaml.Finder)
• Dumper - a Yaml.Dumper to dump a Yaml.Node to his file representation
• Event - Yaml Event class populated by Yaml.Scanner and treat by the Yaml.Processor to build a Yaml.Node from a yaml.file
• ExampleChild - a test class to implements yamlize
• Example - a test class to implements yamlize
• Finder - Finder class used to easily retriew Yaml.Node
• GeeBuilder - a Yaml.GeeBuilder class helping to build vala Gee.Collection with fundamental type to Yaml.Node
• Loader - a Yaml Loader class
• Mapping - a class representing a mapping node
• Node - a class representing a yaml node no matter was his type
• Object - Yaml.Object base class which can be transform to a Yaml.Node structure
• Processor - a class dealing with a sequence of yaml events and composing the Yaml Node Graph
• Register - A Register class responsible to register owner types and related types lists
• Root - a class representing a Yaml Root Node
• Scalar - a class representing a Scalar node
• Scanner - a Yaml scanner class dealing with libyaml to generate a list of Yaml.Event
• Sequence - a class representing a sequence node
• Tag - a Tag class to store handle and value tag for Yaml.Node

Structs:

• ExampleStruct

Enums:

• EVT - enum YAML EVT emit by libyaml (c library)
• FIND_MODE - enum possible find mode of Yaml.Node.mode
• NODE_TYPE - enum possible type of Yaml.Node

Error domains:

• AddNodeError - Yaml.Node add node error

Constants:

• protected const unowned string INSTALL_PATH
• public const unowned string DATA_PATH
• public const unowned string VERSION

Methods:

• public uint8[] serialize (Object? obj, string? dest = null)
  serialize an Object as yaml compressed (GZ) data
• public Root deserialize (uint8[] zdata)
  déserialize a serialized data to a Yaml.Root node
• public string uuid ()

Fields:

• public bool DEBUG
• public bool DBG_SHOW_INDENT
• public bool DBG_SHOW_PARENT
• public bool DBG_SHOW_UUID
• public bool DBG_SHOW_LEVEL
• public bool DBG_SHOW_REF
• public bool DBG_SHOW_COUNT
• public bool DBG_SHOW_TAG
• public bool DBG_SHOW_TYPE
• public FIND_MODE MODE