as_stream Struct Reference

Detailed Description

Stream Interface

To use the stream interface, you will need to create an instance via one of the implementations.

Definition at line 56 of file as_stream.h.

#include "as_stream.h"

Collaboration diagram for as_stream:

Data Fields
void *	data
bool	free
const struct as_stream_hooks_s *	hooks

Related Functions
(Note that these are not member functions.)
static void	as_stream_destroy (as_stream *stream)
static as_stream *	as_stream_init (as_stream *stream, void *data, const as_stream_hooks *hooks)
static as_stream *	as_stream_new (void *data, const as_stream_hooks *hooks)
static as_val *	as_stream_read (const as_stream *stream)
static bool	as_stream_readable (const as_stream *stream)
static void *	as_stream_source (const as_stream *stream)
static bool	as_stream_writable (const as_stream *stream)
static as_stream_status	as_stream_write (const as_stream *stream, as_val *value)

Friends And Related Function Documentation

static void as_stream_destroy ( as_stream *  stream )

related

Destroy the as_stream and associated resources.

Parameters

stream

The stream to destroy.

Returns

0 on success, otherwise 1.

Definition at line 162 of file as_stream.h.

static as_stream * as_stream_init ( as_stream *  stream, void *  data, const as_stream_hooks *  hooks  )

related

Initializes a stack allocated as_stream for a given source and hooks.

Parameters

stream	The stream to initialize.
data	The source feeding the stream
hooks	The hooks that interface with the source

Returns

On success, the initialized stream. Otherwise NULL.

Definition at line 122 of file as_stream.h.

static as_stream * as_stream_new ( void *  data, const as_stream_hooks *  hooks  )

related

Creates a new heap allocated as_stream for a given source and hooks.

Parameters

data	The source feeding the stream
hooks	The hooks that interface with the source

Returns

On success, a new stream. Otherwise NULL.

Definition at line 142 of file as_stream.h.

static as_val * as_stream_read ( const as_stream *  stream )

related

Reads a value from the stream

Parameters

stream

The stream to be read.

Returns

the element read from the stream or STREAM_END

Definition at line 197 of file as_stream.h.

static bool as_stream_readable ( const as_stream *  stream )

related

Is the stream readable? Tests whether the stream has a read function.

Parameters

stream

The stream to test.

Returns

true if the stream can be read from

Definition at line 211 of file as_stream.h.

static void * as_stream_source ( const as_stream *  stream )

related

Get the source for the stream

Parameters

stream

The stream to get the source from

Returns

pointer to the source of the stream

Definition at line 183 of file as_stream.h.

static bool as_stream_writable ( const as_stream *  stream )

related

Is the stream writable? Tests whether the stream has a write function.

Parameters

stream

The stream to test.

Returns

true if the stream can be written to.

Definition at line 241 of file as_stream.h.

static as_stream_status as_stream_write ( const as_stream *  stream, as_val *  value  )

related

Write a value to the stream

Parameters

stream	The stream to write to.
value	The element to write to the stream.

Returns

AS_STREAM_OK on success, otherwise is failure.

Definition at line 226 of file as_stream.h.

Field Documentation

void* as_stream::data

Context data for the stream.

Definition at line 67 of file as_stream.h.

bool as_stream::free

Specifies whether the cf_free() can be used on this stream.

Definition at line 62 of file as_stream.h.

const struct as_stream_hooks_s* as_stream::hooks

Hooks for the stream

Definition at line 72 of file as_stream.h.

---

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

• as_stream.h