Tinyaml file and buffer IO
[Tinyaml]

---

Detailed Description

Define a common interface for file and memory buffer I/O, independantly of non-portable fmemopen.

Readers and Writers in Tinyaml can handle 32-bit words and character strings. A reader can be configured to swap bytes when reading words, so that it can read words serialized in the other endianness. Endianness recognition is done by the user, NOT by the Reader itself.

Internals are not discussed here.

Typedefs
typedef struct _reader_t *	reader_t
	opaque type : generic reader
typedef struct _writer_t *	writer_t
	opaque type : generic writer
Functions
writer_t	file_writer_new (const char *)
	create a new writer associated to given file.
writer_t	buffer_writer_new (char *, word_t)
	create a new writer associated to given buffer of given length.
void	writer_close (writer_t)
	close the given writer.
reader_t	file_reader_new (const char *)
	create a new reader associated to given file.
reader_t	buffer_reader_new (const char *, word_t)
	create a new reader associated to given buffer of given length.
void	reader_swap_endian (reader_t)
	toggle endian swapping for the given reader.
void	reader_close (reader_t)
	close the given reader.
word_t	write_word (writer_t, word_t)
word_t	write_string (writer_t, const char *)
word_t	read_word (reader_t)
const char *	read_string (reader_t)

---

Typedef Documentation

typedef struct _reader_t* reader_t

opaque type : generic reader

typedef struct _writer_t* writer_t

opaque type : generic writer

---

Function Documentation

writer_t file_writer_new

(

const char *

)

create a new writer associated to given file.

writer_t buffer_writer_new	(	char *	,
		word_t
	)

create a new writer associated to given buffer of given length.

void writer_close

(

writer_t

)

close the given writer.

reader_t file_reader_new

(

const char *

)

create a new reader associated to given file.

reader_t buffer_reader_new	(	const char *	,
		word_t
	)

create a new reader associated to given buffer of given length.

void reader_swap_endian

(

reader_t

)

toggle endian swapping for the given reader.

void reader_close

(

reader_t

)

close the given reader.

word_t write_word	(	writer_t	,
		word_t
	)

write a single word

word_t write_string	(	writer_t	,
		const char *
	)

write a character string

word_t read_word

(

reader_t

)

read a single word

const char* read_string

(

reader_t

)

read a character string

---