_pcp_stream_t Struct Reference

An I/O wrapper object backed by a file or a buffer. More...

#include <structs.h>

Public Attributes
FILE *	fd
	The backend FILE stream. More...
Buffer *	b
	The backend Buffer object. More...
Buffer *	cache
	The caching Buffer object (for look ahead read) More...
Buffer *	next
	The caching Next-Buffer object (for look ahead read) More...
Buffer *	save
	Temporary buffer to backup overflow data. More...
uint8_t	is_buffer
	Set to 1 if the backend is a Buffer. More...
uint8_t	eof
	Set to 1 if EOF reached. More...
uint8_t	err
	Set to 1 if an error occured. More...
uint8_t	armor
	Set to 1 if Z85 en/de-coding is requested. More...
uint8_t	determine
	Set to 1 to automatically determine armor mode. More...
uint8_t	firstread
	Internal flag, will be set after first read() More...
size_t	linewr
	Used for Z85 writing, number of chars written on last line. More...
size_t	blocksize
	Blocksize used for z85, if requested. More...
uint8_t	is_output
	marks the stream as output stream More...
uint8_t	have_begin
	flag to indicate we already got the begin header, if any More...
size_t	pos
	remember i/o position More...

Detailed Description

An I/O wrapper object backed by a file or a buffer.

Definition at line 305 of file structs.h.

Member Data Documentation

uint8_t _pcp_stream_t::armor

Set to 1 if Z85 en/de-coding is requested.

Definition at line 314 of file structs.h.

Buffer* _pcp_stream_t::b

The backend Buffer object.

Definition at line 307 of file structs.h.

size_t _pcp_stream_t::blocksize

Blocksize used for z85, if requested.

Definition at line 318 of file structs.h.

Buffer* _pcp_stream_t::cache

The caching Buffer object (for look ahead read)

Definition at line 308 of file structs.h.

uint8_t _pcp_stream_t::determine

Set to 1 to automatically determine armor mode.

Definition at line 315 of file structs.h.

uint8_t _pcp_stream_t::eof

Set to 1 if EOF reached.

Definition at line 312 of file structs.h.

uint8_t _pcp_stream_t::err

Set to 1 if an error occured.

Definition at line 313 of file structs.h.

FILE* _pcp_stream_t::fd

The backend FILE stream.

Definition at line 306 of file structs.h.

uint8_t _pcp_stream_t::firstread

Internal flag, will be set after first read()

Definition at line 316 of file structs.h.

uint8_t _pcp_stream_t::have_begin

flag to indicate we already got the begin header, if any

Definition at line 320 of file structs.h.

uint8_t _pcp_stream_t::is_buffer

Set to 1 if the backend is a Buffer.

Definition at line 311 of file structs.h.

uint8_t _pcp_stream_t::is_output

marks the stream as output stream

Definition at line 319 of file structs.h.

size_t _pcp_stream_t::linewr

Used for Z85 writing, number of chars written on last line.

Definition at line 317 of file structs.h.

Buffer* _pcp_stream_t::next

The caching Next-Buffer object (for look ahead read)

Definition at line 309 of file structs.h.

size_t _pcp_stream_t::pos

remember i/o position

Definition at line 321 of file structs.h.

Buffer* _pcp_stream_t::save

Temporary buffer to backup overflow data.

Definition at line 310 of file structs.h.

---

The documentation for this struct was generated from the following file:

• structs.h