nix::FramedSource Struct Reference

#include <serialise.hh>

Inheritance diagram for nix::FramedSource:

Public Member Functions
	FramedSource (Source &from)
size_t	read (char *data, size_t len) override
Public Member Functions inherited from nix::Source
void	operator() (char *data, size_t len)
virtual bool	good ()
void	drainInto (Sink &sink)
std::string	drain ()

Public Attributes
Source &	from
bool	eof = false
std::vector< char >	pending
size_t	pos = 0

Detailed Description

A source that reads a distinct format of concatenated chunks back into its logical form, in order to guarantee a known state to the original stream, even in the event of errors.

Use with FramedSink, which also allows the logical stream to be terminated in the event of an exception.

Member Function Documentation

read()

size_t nix::FramedSource::read ( char * data, size_t len )

inlineoverridevirtual

Store up to ‘len’ in the buffer pointed to by ‘data’, and return the number of bytes stored. It blocks until at least one byte is available.

Should not return 0 (generally you want to throw EndOfFile), but nothing stops that.

Exceptions

EndOfFile

if there is no more data.

Implements nix::Source.

---

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

• lix/libutil/serialise.hh