All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Fields | Related Functions
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 58 of file as_stream.h.

#include "as_stream.h"

+ Collaboration diagram for as_stream:

Data Fields

void * data
 
bool free
 
struct as_stream_hooks_s * hooks
 

Related Functions

(Note that these are not member functions.)

void as_stream_destroy (as_stream *stream)
 
as_streamas_stream_init (as_stream *stream, void *data, const as_stream_hooks *hooks)
 
as_streamas_stream_new (void *data, const as_stream_hooks *hooks)
 
as_valas_stream_read (const as_stream *stream)
 
bool as_stream_readable (const as_stream *stream)
 
void * as_stream_source (const as_stream *stream)
 
bool as_stream_writable (const as_stream *stream)
 
as_stream_status as_stream_write (const as_stream *stream, as_val *value)
 

Friends And Related Function Documentation

void as_stream_destroy ( as_stream stream)
related

Destroy the as_stream and associated resources.

Parameters
streamThe stream to destroy.
Returns
0 on success, otherwise 1.

Definition at line 158 of file as_stream.h.

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
streamThe stream to initialize.
dataThe source feeding the stream
hooksThe hooks that interface with the source
Returns
On success, the initialized stream. Otherwise NULL.

Definition at line 118 of file as_stream.h.

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
dataThe source feeding the stream
hooksThe hooks that interface with the source
Returns
On success, a new stream. Otherwise NULL.

Definition at line 138 of file as_stream.h.

as_val * as_stream_read ( const as_stream stream)
related

Reads a value from the stream

Parameters
streamThe stream to be read.
Returns
the element read from the stream or STREAM_END

Definition at line 193 of file as_stream.h.

bool as_stream_readable ( const as_stream stream)
related

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

Parameters
streamThe stream to test.
Returns
true if the stream can be read from

Definition at line 207 of file as_stream.h.

void * as_stream_source ( const as_stream stream)
related

Get the source for the stream

Parameters
streamThe stream to get the source from
Returns
pointer to the source of the stream

Definition at line 179 of file as_stream.h.

bool as_stream_writable ( const as_stream stream)
related

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

Parameters
streamThe stream to test.
Returns
true if the stream can be written to.

Definition at line 237 of file as_stream.h.

as_stream_status as_stream_write ( const as_stream stream,
as_val value 
)
related

Write a value to the stream

Parameters
streamThe stream to write to.
valueThe element to write to the stream.
Returns
AS_STREAM_OK on success, otherwise is failure.

Definition at line 222 of file as_stream.h.

Field Documentation

void* as_stream::data

Context data for the stream.

Definition at line 69 of file as_stream.h.

bool as_stream::free

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

Definition at line 64 of file as_stream.h.

struct as_stream_hooks_s* as_stream::hooks

Hooks for the stream

Definition at line 74 of file as_stream.h.


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