include/ecoli_yaml.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2018, Olivier MATZ <zer0@droids-corp.org>
   3  */
   4
   5 /**
   6  * Interface to import/export ecoli data structures in YAML.
   7  */
   8
   9 #ifndef ECOLI_NODE_YAML_
  10 #define ECOLI_NODE_YAML_
  11
  12 struct ec_node;
  13
  14 /**
  15  * Parse a YAML file and build an ec_node tree from it.
  16  *
  17  * @param filename
  18  *   The path to the file to be parsed.
  19  * @return
  20  *   The ec_node tree on success, or NULL on error (errno is set).
  21  *   The returned node must be freed by the caller with ec_node_free().
  22  */
  23 struct ec_node *ec_yaml_import(const char *filename);
  24
  25 #endif