libyang  2.1.55
libyang is YANG data modelling language parser and toolkit written (and providing API) in C.
set.h
Go to the documentation of this file.
1 
15 #ifndef LY_SET_H_
16 #define LY_SET_H_
17 
18 #include <stdint.h>
19 
20 #include "log.h"
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
46 struct ly_set {
47  uint32_t size;
48  uint32_t count;
50  union {
51  struct lyd_node **dnodes;
52  struct lysc_node **snodes;
53  void **objs;
54  };
55 };
56 
65 LIBYANG_API_DECL LY_ERR ly_set_new(struct ly_set **set_p);
66 
79 LIBYANG_API_DECL LY_ERR ly_set_dup(const struct ly_set *set, void *(*duplicator)(const void *obj), struct ly_set **newset_p);
80 
94 LIBYANG_API_DECL LY_ERR ly_set_add(struct ly_set *set, const void *object, ly_bool list, uint32_t *index_p);
95 
111 LIBYANG_API_DECL LY_ERR ly_set_merge(struct ly_set *trg, const struct ly_set *src, ly_bool list, void *(*duplicator)(const void *obj));
112 
121 LIBYANG_API_DECL ly_bool ly_set_contains(const struct ly_set *set, const void *object, uint32_t *index_p);
122 
129 LIBYANG_API_DECL void ly_set_clean(struct ly_set *set, void (*destructor)(void *obj));
130 
142 LIBYANG_API_DECL LY_ERR ly_set_rm(struct ly_set *set, void *object, void (*destructor)(void *obj));
143 
155 LIBYANG_API_DECL LY_ERR ly_set_rm_index(struct ly_set *set, uint32_t index, void (*destructor)(void *obj));
156 
164 LIBYANG_API_DECL void ly_set_free(struct ly_set *set, void (*destructor)(void *obj));
165 
173 LIBYANG_API_DECL void ly_set_erase(struct ly_set *set, void (*destructor)(void *obj));
174 
177 #ifdef __cplusplus
178 }
179 #endif
180 
181 #endif /* LY_SET_H_ */
LY_ERR
libyang's error codes returned by the libyang functions.
Definition: log.h:251
uint32_t count
Definition: set.h:48
uint32_t size
Definition: set.h:47
LIBYANG_API_DECL void ly_set_clean(struct ly_set *set, void(*destructor)(void *obj))
Remove all objects from the set, but keep the set container for further use.
LIBYANG_API_DECL void ly_set_erase(struct ly_set *set, void(*destructor)(void *obj))
Alternative to the ly_set_free() for static ly_set objects - in contrast to ly_set_free() it does not...
LIBYANG_API_DECL void ly_set_free(struct ly_set *set, void(*destructor)(void *obj))
Free the ly_set data. If the destructor is not provided, it frees only the set structure content,...
LIBYANG_API_DECL LY_ERR ly_set_merge(struct ly_set *trg, const struct ly_set *src, ly_bool list, void *(*duplicator)(const void *obj))
Add all objects from src to trg.
LIBYANG_API_DECL LY_ERR ly_set_rm(struct ly_set *set, void *object, void(*destructor)(void *obj))
Remove an object from the set.
LIBYANG_API_DECL LY_ERR ly_set_dup(const struct ly_set *set, void *(*duplicator)(const void *obj), struct ly_set **newset_p)
Duplicate the existing set.
LIBYANG_API_DECL ly_bool ly_set_contains(const struct ly_set *set, const void *object, uint32_t *index_p)
Learn whether the set contains the specified object.
LIBYANG_API_DECL LY_ERR ly_set_add(struct ly_set *set, const void *object, ly_bool list, uint32_t *index_p)
Add an object into the set.
LIBYANG_API_DECL LY_ERR ly_set_new(struct ly_set **set_p)
Create and initiate new ly_set structure.
LIBYANG_API_DECL LY_ERR ly_set_rm_index(struct ly_set *set, uint32_t index, void(*destructor)(void *obj))
Remove an object on the specific set index.
Structure to hold a set of (not necessary somehow connected) objects. Usually used for lyd_node,...
Definition: set.h:46
Compiled YANG data node.
Definition: tree_schema.h:1398
Logger manipulation routines and error definitions.
uint8_t ly_bool
Type to indicate boolean value.
Definition: log.h:28
Generic structure for a data node.
Definition: tree_data.h:781