scsl::Buffer Class Reference

Basic line buffer. More...

#include <Buffer.h>

Public Member Functions
	Buffer ()
	Construct an empty buffer with no memory allocated.
	Buffer (size_t initialCapacity)
	Buffer (const char *s)
	Construct with a C-style string.
	Buffer (const std::string &s)
	\buffer Construct with an initial string.
	~Buffer ()
uint8_t *	Contents () const
	Retrieve the buffer's contents.
std::string	ToString () const
size_t	Length () const
	The length of data stored in the buffer.
size_t	Capacity () const
	Return the amount of memory allocated for the Buffer.
bool	Append (const char *s)
	Append a C-style string to the end of the buffer.
bool	Append (const std::string &s)
bool	Append (const uint8_t *data, const size_t datalen)
	Append a byte buffer to the end of the buffer.
bool	Append (const uint8_t c)
	Append a single character to the end of the buffer.
bool	Insert (const size_t index, const char *s)
	Insert a C-style string into the buffer at index.
bool	Insert (const size_t index, const std::string &s)
	Insert a string into the buffer at index.
bool	Insert (const size_t index, const uint8_t *data, const size_t datalen)
	Insert a uint8_t buffer into the buffer at index.
bool	Insert (const size_t index, const uint8_t c)
	Insert a character into the buffer at index.
bool	Remove (const size_t index, const size_t count)
	Remove count bytes from the buffer at index.
bool	Remove (size_t index)
	Remove removes a single byte from the buffer.
void	Resize (size_t newCapacity)
	Changes the capacity of the buffer to newCapacity.
size_t	Trim ()
	Resize the Buffer capacity based on its length.
void	DisableAutoTrim ()
void	EnableAutoTrim ()
bool	AutoTrimIsEnabled ()
void	Clear ()
void	Reclaim ()
void	HexDump (std::ostream &os)
uint8_t &	operator[] (size_t index)

Friends
bool	operator== (const Buffer &lhs, const Buffer &rhs)

Detailed Description

Basic line buffer.

The buffer manages its own internal memory, growing and shrinking as needed. Its capacity is separate from its length; the optimal capacity is determined as the nearest power of two that is greater than the length of the buffer. For example, if the buffer has a length of 5 bytes, 8 bytes will be allocated. If the buffer is 9 bytes, 16 bytes will be allocated.

The Append and Insert methods will call Resize as necessary to grow the buffer. Similarly the Remove methods will call Trim to reclaim some memory if possible, but only if AutoTrimIsEnabled (it is by default).

Constructor & Destructor Documentation

Buffer() [1/4]

scsl::Buffer::Buffer

(

)

Construct an empty buffer with no memory allocated.

Buffer() [2/4]

scsl::Buffer::Buffer ( size_t  initialCapacity )

explicit

\buffer Constructor with explicit memory capacity.

Parameters

initialCapacity

The initial allocation size for the buffer.

Buffer() [3/4]

scsl::Buffer::Buffer ( const char *  s )

explicit

Construct with a C-style string.

Buffer() [4/4]

scsl::Buffer::Buffer ( const std::string &  s )

explicit

\buffer Construct with an initial string.

~Buffer()

scsl::Buffer::~Buffer

(

)

Member Function Documentation

Append() [1/4]

bool scsl::Buffer::Append

(

const char *

s

)

Append a C-style string to the end of the buffer.

Parameters

s	The string to append.

Returns

True if the Buffer was resized.

Append() [2/4]

bool scsl::Buffer::Append

(

const std::string &

s

)

Append Append a string to the end of the buffer.

Parameters

s	The string to append.

Returns

True if the Buffer was resized.

Append() [3/4]

bool scsl::Buffer::Append	(	const uint8_t *	data,
		const size_t	datalen
	)

Append a byte buffer to the end of the buffer.

Parameters

data	The byte buffer to insert.
datalen	The length of the byte buffer.

Returns

True if the Buffer was resized.

Append() [4/4]

bool scsl::Buffer::Append

(

const uint8_t

c

)

Append a single character to the end of the buffer.

Parameters

c	The character to append.

Returns

True if the Buffer was resized.

AutoTrimIsEnabled()

bool scsl::Buffer::AutoTrimIsEnabled

(

)

AutoTrimIsEnabled returns true if autotrim is enabled.

Returns

Remove will call Trim.

Capacity()

size_t scsl::Buffer::Capacity

(

)

const

Return the amount of memory allocated for the Buffer.

Clear()

void scsl::Buffer::Clear

(

)

Clear removes the data stored in the buffer. It will not call Trim; the capacity of the buffer will not be altered.

Contents()

uint8_t * scsl::Buffer::Contents

(

)

const

Retrieve the buffer's contents.

DisableAutoTrim()

void scsl::Buffer::DisableAutoTrim

(

)

DisableAutoTrim prevents the Buffer from automatically trimming memory after a call to Remove.

EnableAutoTrim()

void scsl::Buffer::EnableAutoTrim

(

)

EnableAutoTrim enables automatically trimming memory after calls to Remove.

HexDump()

void scsl::Buffer::HexDump

(

std::ostream &

os

)

HexDump dumps the data in the buffer to the output stream; it is intended as a debugging tool.

Parameters

os	The output stream to write to.

Insert() [1/4]

bool scsl::Buffer::Insert	(	const size_t	index,
		const char *	s
	)

Insert a C-style string into the buffer at index.

Note

As this is intended for use in text editing, an insert into a buffer after the length will insert spaces before the content.

Parameters

index	The index to insert the string at.
s	The string to insert.

Returns

True if the Buffer was resized.

Insert() [2/4]

bool scsl::Buffer::Insert	(	const size_t	index,
		const std::string &	s
	)

Insert a string into the buffer at index.

Note

As this is intended for use in text editing, an insert into a buffer after the length will insert spaces before the content.

Parameters

index	The index the string should be inserted at.
s	The string to insert.

Returns

True if the Buffer was resized.

Insert() [3/4]

bool scsl::Buffer::Insert	(	const size_t	index,
		const uint8_t *	data,
		const size_t	datalen
	)

Insert a uint8_t buffer into the buffer at index.

Note

As this is intended for use in text editing, an insert into a buffer after the length will insert spaces before the content.

Parameters

index	The index to insert the buffer at.
data	The buffer to insert.
datalen	The size of the data buffer.

Returns

True if the Buffer was resized.

Insert() [4/4]

bool scsl::Buffer::Insert	(	const size_t	index,
		const uint8_t	c
	)

Insert a character into the buffer at index.

Note

As this is intended for use in text editing, an insert into a buffer after the length will insert spaces before the content.

Parameters

index	The index to insert the character at.
c	The character to insert.

Returns

True if the Buffer was resized.

Length()

size_t scsl::Buffer::Length

(

)

const

The length of data stored in the buffer.

Returns

The number of bytes stored in the Buffer.

operator[]()

uint8_t & scsl::Buffer::operator[]

(

size_t

index

)

This operator allows the data in the buffer to be accessed as if it were an array. If the index is out of bounds, it will throw a range_error.

Exceptions

std::range_error.

Parameters

index

The index to retrieve.

Returns

Reclaim()

void scsl::Buffer::Reclaim

(

)

Reclaim the memory in the buffer: the buffer will call Clear, followed by deleting any allocated memory.

Remove() [1/2]

bool scsl::Buffer::Remove	(	const size_t	index,
		const size_t	count
	)

Remove count bytes from the buffer at index.

Parameters

index	The starting index to remove bytes from.
count	The number of bytes to remove.

Returns

True if the Buffer was resized.

Remove() [2/2]

bool scsl::Buffer::Remove

(

size_t

index

)

Remove removes a single byte from the buffer.

Parameters

index

The index pointing to the byte to be removed.

Returns

True if the Buffer was resized.

Resize()

void scsl::Buffer::Resize

(

size_t

newCapacity

)

Changes the capacity of the buffer to newCapacity.

If newCapacity is less than the length of the Buffer, it will remove enough bytes from the end to make this happen.

Parameters

newCapacity

The new capacity for the Buffer.

ToString()

std::string scsl::Buffer::ToString

(

)

const

Trim()

size_t scsl::Buffer::Trim

(

)

Resize the Buffer capacity based on its length.

Returns

The new capacity of the Buffer.

Friends And Related Symbol Documentation

operator==

bool operator== ( const Buffer &  lhs, const Buffer &  rhs  )

friend

Two buffers are equal if their lengths are the same and their contents are the same. Equality is irrespective of their capacities.

---

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

• include/scsl/Buffer.h