stream.h File Reference

Borrower-facing runtime operations for the stream port. More...

#include "stream/borrowers/stream_types.h"
#include "policy/lexleo_cstd_types.h"

Include dependency graph for stream.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
size_t	stream_read (stream_t *s, void *buf, size_t n, stream_status_t *st)
	Read bytes from a stream.
size_t	stream_write (stream_t *s, const void *buf, size_t n, stream_status_t *st)
	Write bytes to a stream.
stream_status_t	stream_flush (stream_t *s)
	Flush a stream.

Detailed Description

This header exposes the public runtime operations used to interact with a borrowed stream_t handle.

Definition in file stream.h.

Function Documentation

stream_flush()

stream_status_t stream_flush

(

stream_t *

s

)

Parameters

[in]

s

Stream handle to flush.

Returns

Operation status.

This function exposes the borrower-facing flush operation of the stream port.

Definition at line 62 of file stream.c.

stream_read()

size_t stream_read	(	stream_t *	s,
		void *	buf,
		size_t	n,
		stream_status_t *	st
	)

Parameters

[in]	s	Stream handle to read from.
[out]	buf	Destination buffer receiving up to n bytes.
[in]	n	Maximum number of bytes to read.
[out]	st	Optional status output.

Returns

Number of bytes actually read.

This function exposes the borrower-facing read operation of the stream port.

If n == 0, the function returns 0 and, when st != NULL, reports STREAM_STATUS_OK.

Definition at line 19 of file stream.c.

stream_write()

size_t stream_write	(	stream_t *	s,
		const void *	buf,
		size_t	n,
		stream_status_t *	st
	)

Parameters

[in]	s	Stream handle to write to.
[in]	buf	Source buffer containing up to n bytes to write.
[in]	n	Maximum number of bytes to write.
[out]	st	Optional status output.

Returns

Number of bytes actually written.

This function exposes the borrower-facing write operation of the stream port.

If n == 0, the function returns 0 and, when st != NULL, reports STREAM_STATUS_OK.

Definition at line 38 of file stream.c.