master/html/parser__data_8h_source.html

 #ifndef LY_PARSER_DATA_H_

 #define LY_PARSER_DATA_H_


 #include "tree_data.h"


 #ifdef __cplusplus

 extern "C" {

 #endif


 struct ly_in;


 /* note: keep the lower 16bits free for use by LYD_VALIDATE_ flags. They are not supposed to be combined together,

  * but since they are used (as a separate parameter) together in some functions, we want to keep them in a separated

  * range to be able detect that the caller put wrong flags into the parser/validate options parameter. */

 #define LYD_PARSE_ONLY      0x010000

 #define LYD_PARSE_STRICT    0x020000

 #define LYD_PARSE_OPAQ      0x040000

 #define LYD_PARSE_NO_STATE  0x080000

 #define LYD_PARSE_LYB_MOD_UPDATE  0x100000

 #define LYD_PARSE_ORDERED 0x200000

 #define LYD_PARSE_SUBTREE 0x400000

 #define LYD_PARSE_WHEN_TRUE 0x800000

 #define LYD_PARSE_NO_NEW 0x1000000

 #define LYD_PARSE_OPTS_MASK 0xFFFF0000

 #define LYD_VALIDATE_NO_STATE   0x0001

 #define LYD_VALIDATE_PRESENT    0x0002

 #define LYD_VALIDATE_OPTS_MASK  0x0000FFFF

 LIBYANG_API_DECL LY_ERR lyd_parse_data(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,

         uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);


 LIBYANG_API_DECL LY_ERR lyd_parse_data_mem(const struct ly_ctx *ctx, const char *data, LYD_FORMAT format, uint32_t parse_options,

         uint32_t validate_options, struct lyd_node **tree);


 LIBYANG_API_DECL LY_ERR lyd_parse_data_fd(const struct ly_ctx *ctx, int fd, LYD_FORMAT format, uint32_t parse_options,

         uint32_t validate_options, struct lyd_node **tree);


 LIBYANG_API_DECL LY_ERR lyd_parse_data_path(const struct ly_ctx *ctx, const char *path, LYD_FORMAT format,

         uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);


 LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,

         LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree);


 enum lyd_type {

     LYD_TYPE_DATA_YANG = 0, /* generic YANG instance data */

     LYD_TYPE_RPC_YANG,      /* instance of a YANG RPC/action request with only "input" data children,

                                including all parents in case of an action */

     LYD_TYPE_NOTIF_YANG,    /* instance of a YANG notification, including all parents in case of a nested one */

     LYD_TYPE_REPLY_YANG,    /* instance of a YANG RPC/action reply with only "output" data children,

                                including all parents in case of an action */


     LYD_TYPE_RPC_NETCONF,   /* complete NETCONF RPC invocation as defined for

                                [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and

                                [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */

     LYD_TYPE_NOTIF_NETCONF, /* complete NETCONF notification message as defined for

                                [notification](https://tools.ietf.org/html/rfc7950#section-7.16.2) */

     LYD_TYPE_REPLY_NETCONF  /* complete NETCONF RPC reply as defined for

                                [RPC](https://tools.ietf.org/html/rfc7950#section-7.14.4) and

                                [action](https://tools.ietf.org/html/rfc7950#section-7.15.2) */

 };

 LIBYANG_API_DECL LY_ERR lyd_parse_op(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format,

         enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);


 LIBYANG_API_DECL LY_ERR lyd_parse_ext_op(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in,

         LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op);


 LIBYANG_API_DECL LY_ERR lyd_validate_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t val_opts,

         struct lyd_node **diff);


 LIBYANG_API_DECL LY_ERR lyd_validate_module(struct lyd_node **tree, const struct lys_module *module, uint32_t val_opts,

         struct lyd_node **diff);


 LIBYANG_API_DECL LY_ERR lyd_validate_op(struct lyd_node *op_tree, const struct lyd_node *dep_tree, enum lyd_type data_type,

         struct lyd_node **diff);


 #ifdef __cplusplus

 }

 #endif


 #endif /* LY_PARSER_DATA_H_ */

LYD_TYPE_RPC_NETCONF
Definition: parser_data.h:331

lyd_node
Generic structure for a data node.
Definition: tree_data.h:781

LYD_TYPE_NOTIF_YANG
Definition: parser_data.h:327

lysc_ext_instance
YANG extension compiled instance.
Definition: plugins_exts.h:436

lyd_validate_module
LIBYANG_API_DECL LY_ERR lyd_validate_module(struct lyd_node **tree, const struct lys_module *module, uint32_t val_opts, struct lyd_node **diff)
Fully validate a data tree of a module.

lyd_parse_ext_op
LIBYANG_API_DECL LY_ERR lyd_parse_ext_op(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op)
Parse extension data into an operation data tree following only the specification from the given exte...

LYD_TYPE_RPC_YANG
Definition: parser_data.h:325

LYD_TYPE_NOTIF_NETCONF
Definition: parser_data.h:334

lyd_node::parent
struct lyd_node_inner * parent
Definition: tree_data.h:788

lyd_validate_op
LIBYANG_API_DECL LY_ERR lyd_validate_op(struct lyd_node *op_tree, const struct lyd_node *dep_tree, enum lyd_type data_type, struct lyd_node **diff)
Validate an RPC/action request, reply, or notification. Only the operation data tree (input/output/no...

lyd_validate_all
LIBYANG_API_DECL LY_ERR lyd_validate_all(struct lyd_node **tree, const struct ly_ctx *ctx, uint32_t val_opts, struct lyd_node **diff)
Fully validate a data tree.

tree_data.h
libyang representation of YANG data trees.

ly_in
Parser input structure specifying where the data are read.

LYD_FORMAT
LYD_FORMAT
Data input/output formats supported by libyang parser and printer functions.
Definition: tree_data.h:533

lyd_type
lyd_type
Definition: parser_data.h:323

LYD_TYPE_REPLY_YANG
Definition: parser_data.h:328

lys_module
Available YANG schema tree structures representing YANG module.
Definition: tree_schema.h:2097

lyd_parse_ext_data
LIBYANG_API_DECL LY_ERR lyd_parse_ext_data(const struct lysc_ext_instance *ext, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) data from the input handler as an extension data tree following the schema tree ...

lyd_parse_data_path
LIBYANG_API_DECL LY_ERR lyd_parse_data_path(const struct ly_ctx *ctx, const char *path, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.

LYD_TYPE_DATA_YANG
Definition: parser_data.h:324

lyd_parse_op
LIBYANG_API_DECL LY_ERR lyd_parse_op(const struct ly_ctx *ctx, struct lyd_node *parent, struct ly_in *in, LYD_FORMAT format, enum lyd_type data_type, struct lyd_node **tree, struct lyd_node **op)
Parse YANG data into an operation data tree.

LYD_TYPE_REPLY_NETCONF
Definition: parser_data.h:336

LY_ERR
LY_ERR
libyang&#39;s error codes returned by the libyang functions.
Definition: log.h:254

lyd_parse_data_mem
LIBYANG_API_DECL LY_ERR lyd_parse_data_mem(const struct ly_ctx *ctx, const char *data, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.

ly_ctx
libyang context handler.

lyd_parse_data_fd
LIBYANG_API_DECL LY_ERR lyd_parse_data_fd(const struct ly_ctx *ctx, int fd, LYD_FORMAT format, uint32_t parse_options, uint32_t validate_options, struct lyd_node **tree)
Parse (and validate) input data as a YANG data tree.