---

dt_stream.h File Reference

Go to the source code of this file.

Data Structures
struct	dt_stream_step_
	Data providing all required data for a single step of the traversal of a data tree. More...
Typedefs
typedef dt_stream_step_	dt_stream_step
	Data providing all required data for a single step of the traversal of a data tree.
typedef dt_reader_	dt_reader
typedef dt_writer_	dt_writer
Enumerations
enum	dt_step_kind {   dt_leaf, dt_rec_in, dt_rec_out, dt_arr_in,   dt_arr_out, dt_end }
	Identifier defining the contents of a dt_stream_step. More...
Functions
dt_bool	dt_read (dt_reader *obj, dt_stream_step *step)
	Retrieve a streaming step from obj into step.
void	dt_free_reader (dt_reader *obj)
	Destroy and free a dt_reader object.
dt_bool	dt_write (dt_writer *obj, dt_stream_step const *step)
	Transmit the streaming step in step to obj.
void	dt_free_writer (dt_writer *obj)
	Destroy and free a dt_writer object.

---

Typedef Documentation

typedef struct dt_reader_ dt_reader

Definition at line 26 of file dt_stream.h.

typedef struct dt_stream_step_ dt_stream_step

Data providing all required data for a single step of the traversal of a data tree.

typedef struct dt_writer_ dt_writer

Definition at line 30 of file dt_stream.h.

---

Enumeration Type Documentation

enum dt_step_kind

Identifier defining the contents of a dt_stream_step. Enumeration values: dt_leaf  Leaf data is provided in val and val_len. Key data is provided, if within a record. dt_rec_in  Start contents of a record node. Only key data is provided, if within a record. dt_rec_out  End of a record block. No key or data information is provided. dt_arr_in  Start contents of an array node. Only key data is provided, if within a record. dt_arr_out  End of a record block. No key or data information is provided. dt_end  Marks the end of the transmission of a data tree. No Key or data provided. Definition at line 7 of file dt_stream.h.

---

Function Documentation

void dt_free_reader (  dt_reader *  obj  )

Destroy and free a dt_reader object. Definition at line 28 of file dt_stream_base.c.

void dt_free_writer (  dt_writer *  obj  )

Destroy and free a dt_writer object. Definition at line 53 of file dt_stream_base.c.

dt_bool dt_read (  dt_reader *  obj, dt_stream_step *  step )

Retrieve a streaming step from obj into step. This is a polymorphic function, which will use a subclass-specific forwarding function stored within the object. Returns: A non-zero value if the operation was successful. Definition at line 19 of file dt_stream_base.c.

dt_bool dt_write (  dt_writer *  obj, dt_stream_step const *  step )

Transmit the streaming step in step to obj. This is a polymorphic function, which will use a subclass-specific forwarding function stored within the object. Returns: A non-zero value if the operation was successful. Definition at line 44 of file dt_stream_base.c.

---