A reference-counting, copy-on-write, threadsafe container for arbitrary binary data. More...

#include <Blob.h++>

Collaboration diagram for Blob:

Public Member Functions
	Blob ()
	Construct a new, empty Blob. More...

	Blob (byte_t *data, uint_t length, bool copy=true)
	Construct a new Blob from a byte array. More...

	Blob (const Blob &other)
	Copy constructor. More...

	Blob (const byte_t *data, uint_t length)
	Construct a new Blob from a byte array. More...

	~Blob ()
	Destructor. More...

uint_t	getLength () const
	Get the length of the Blob. More...

uint_t	length () const
	Get the length of the Blob. More...

void	setLength (uint_t length)
	Set the length of the Blob. More...

byte_t *	getData ()
	Get a pointer to the beginning of the data in the Blob. More...

const byte_t *	getData () const
	Get a pointer to the beginning of the data in the Blob. More...

Blob &	clear ()
	Clear the Blob. More...

bool	isEmpty () const
	Test if the Blob is empty. More...

bool	isNull () const
	Test if the Blob is null. More...

Blob &	append (const byte_t *data, uint_t length)
	Append a byte array to the Blob. More...

Blob &	append (const char *str, uint_t length=0)
	Append a character array to the Blob. More...

int	indexOf (byte_t b, uint_t fromIndex=0) const
	Find the first occurrence of a given byte in the Blob. More...

int	indexOf (const byte_t *buf, uint_t length, uint_t fromIndex=0) const
	Find the first occurrence of a given byte sequence in the Blob. More...

int	lastIndexOf (byte_t b, uint_t fromIndex=END) const
	Find the last occurrence of a given byte in the Blob. More...

int	lastIndexOf (const byte_t *buf, uint_t length, uint_t fromIndex=END) const
	Find the last occurrence of a given byte sequence in the Blob. More...

bool	contains (byte_t b) const
	Determine if the Blob contains a given byte. More...

int	compareTo (const Blob &other) const
	Compare this Blob to another. More...

Blob &	operator= (const Blob &other)
	Assignment operator. More...

byte_t &	operator[] (int index)
	Array index operator. More...

byte_t	operator[] (int index) const
	Array index operator. More...

bool	operator! () const
	Unary NOT operator. More...

Blob &	operator+= (byte_t b)
	Append a byte onto the end of the Blob. More...

Blob &	operator+= (int v)
	Append a value onto the end of the Blob. More...

Blob &	operator+= (const char *str)
	Append a character string onto the end of the Blob. More...

Blob &	operator+= (const Blob &blob)
	Append (a copy of) the contents of another Blob onto the end of the Blob. More...

Blob &	operator<< (byte_t val)
	Append operator. More...

Blob &	operator<< (int val)
	Append operator. More...

Blob &	operator<< (const char *str)
	Append operator. More...

uint_t	hash (uint_t modulo=256) const
	Compute a hashcode for the Blob. More...

Static Public Attributes
static const Blob	null
	The null Blob. More...

static const uint_t	END = 0xFFFFFFFF
	A pseudo-index indicating the end of the blob. More...

Detailed Description

A reference-counting, copy-on-write, threadsafe container for arbitrary binary data.

Author: Mark Lindner

Constructor & Destructor Documentation

◆ Blob() [1/4]

Blob ( )

Construct a new, empty Blob.

◆ Blob() [2/4]

Blob	(	byte_t *	data,
		uint_t	length,
		bool	copy = `true`
	)

Construct a new Blob from a byte array.

Parameters

data	The byte array to copy or inherit.
length	The length of the array.
copy	If true, the byte array is copied into the Blob; otherwise the byte array is inherited.

◆ Blob() [3/4]

Blob ( const Blob & other )

Copy constructor.

◆ Blob() [4/4]

Blob	(	const byte_t *	data,
		uint_t	length
	)

Construct a new Blob from a byte array.

Parameters

data	The array to copy.
length	The length of the array.

◆ ~Blob()

~Blob ( )

Destructor.

Member Function Documentation

◆ append() [1/2]

Blob & append	(	const byte_t *	data,
		uint_t	length
	)

Append a byte array to the Blob.

Parameters

data	The array to append.
length	The length of the array.

◆ append() [2/2]

Blob & append	(	const char *	str,
		uint_t	length = `0`
	)

Append a character array to the Blob.

Parameters

str	The array to append.
length	The number of characters from the string to append, or 0 to append the entire string (up to, but not including, the NUL terminator).

◆ clear()

Blob& clear ( )

inline

Clear the Blob.

Sets the length of the Blob to 0.

◆ compareTo()

int compareTo ( const Blob & other ) const

Compare this Blob to another.

Parameters

other The Blob to compare to.

Returns: A negative value if this Blob is "less" than other, a positive value if it is "greater" than other, and 0 if they are "equal".

◆ contains()

bool contains ( byte_t b ) const

inline

Determine if the Blob contains a given byte.

Parameters

b	The byte to search for.

Returns: true if the Blob contains at least one occurrence of the byte, false otherwise.

◆ getData() [1/2]

byte_t* getData ( )

inline

Get a pointer to the beginning of the data in the Blob.

◆ getData() [2/2]

const byte_t* getData ( ) const

inline

Get a pointer to the beginning of the data in the Blob.

◆ getLength()

uint_t getLength ( ) const

inline

Get the length of the Blob.

Returns: The length, in bytes, or 0 if the Blob is null.

◆ hash()

uint_t hash ( uint_t modulo = 256 ) const

Compute a hashcode for the Blob.

Parameters

modulo The desired range for the hashcode.

Returns: A hashcode in the range [0, modulo).

◆ indexOf() [1/2]

int indexOf	(	byte_t	b,
		uint_t	fromIndex = `0`
	)		const

Find the first occurrence of a given byte in the Blob.

Parameters

b	The byte to search for.
fromIndex	The start index from which to begin searching.

Returns: The index of the first occurrence of the byte, or -1 if the byte was not found.

◆ indexOf() [2/2]

int indexOf	(	const byte_t *	buf,
		uint_t	length,
		uint_t	fromIndex = `0`
	)		const

Find the first occurrence of a given byte sequence in the Blob.

Parameters

buf	The buffer containing the byte sequence to search for.
length	The length of the sequence.
fromIndex	The start index from which to begin searching.

Returns: The index of the first occurrence of the byte sequence, or -1 if the sequence was not found.

◆ isEmpty()

bool isEmpty ( ) const

inline

Test if the Blob is empty.

Returns: true if the Blob is null or has length 0, false otherwise.

◆ isNull()

bool isNull ( ) const

inline

Test if the Blob is null.

Returns: true if the Blob is null, false otherwise.

◆ lastIndexOf() [1/2]

int lastIndexOf	(	byte_t	b,
		uint_t	fromIndex = `END`
	)		const

Find the last occurrence of a given byte in the Blob.

Parameters

b	The byte to search for.
fromIndex	The index from which to begin searching backwards, or END to start at the end of the Blob.

Returns: The index of the last occurrence of the byte, or -1 if the byte was not found.

◆ lastIndexOf() [2/2]

int lastIndexOf	(	const byte_t *	buf,
		uint_t	length,
		uint_t	fromIndex = `END`
	)		const

Find the last occurrence of a given byte sequence in the Blob.

Parameters

buf	The buffer containing the byte sequence to search for.
length	The length of the sequence.
fromIndex	The index from which to begin searching backwards, or END to start at the end of the Blob.

Returns: The index of the last occurrence of the byte sequence, or -1 if the sequence was not found.

◆ length()

uint_t length ( ) const

inline

Get the length of the Blob.

Returns: The length, in bytes, or 0 if the Blob is null.

◆ operator!()

bool operator! ( ) const

inline

Unary NOT operator.

Returns: true if the Blob is null, false otherwise.

◆ operator+=() [1/4]

Blob& operator+= ( byte_t b )

inline

Append a byte onto the end of the Blob.

Parameters

b	The byte to append.

◆ operator+=() [2/4]

Blob& operator+= ( int v )

inline

Append a value onto the end of the Blob.

Parameters

v	The value to append. The value will be converted to a byte, which will then be appended to the blob.

◆ operator+=() [3/4]

Blob& operator+= ( const char * str )

inline

Append a character string onto the end of the Blob.

Parameters

str	The string to append.

◆ operator+=() [4/4]

Blob& operator+= ( const Blob & blob )

inline

Append (a copy of) the contents of another Blob onto the end of the Blob.

Parameters

blob	The Blob to append.

◆ operator<<() [1/3]

Blob& operator<< ( byte_t val )

inline

Append operator.

◆ operator<<() [2/3]

Blob& operator<< ( int val )

inline

Append operator.

◆ operator<<() [3/3]

Blob& operator<< ( const char * str )

inline

Append operator.

◆ operator=()

Blob & operator= ( const Blob & other )

Assignment operator.

◆ operator[]() [1/2]

byte_t & operator[] ( int index )

Array index operator.

Obtain a reference to the byte at the given offset in the Blob.

Parameters

index The index.

Returns: A reference to the byte at the specified index.

Exceptions

OutOfBoundsException If index is out of range.

◆ operator[]() [2/2]

byte_t operator[] ( int index ) const

Array index operator.

Obtain a copy of the byte at the given offset in the Blob.

Parameters

index The index.

Returns: The byte at the specified index.

Exceptions

OutOfBoundsException If index is out of range.

◆ setLength()

void setLength ( uint_t length )

Set the length of the Blob.

If the length is smaller than the current length, the Blob is truncated to the new length. If the new length is greater than the current length, the Blob is extended to the new length, and the new bytes are initialized to 0.

Parameters

length The new length.

Member Data Documentation

◆ END

const uint_t END = 0xFFFFFFFF

static

A pseudo-index indicating the end of the blob.

◆ null

const Blob null

static

The null Blob.

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

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Blob() [1/4]

◆ Blob() [2/4]

◆ Blob() [3/4]

◆ Blob() [4/4]

◆ ~Blob()

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ clear()

◆ compareTo()

◆ contains()

◆ getData() [1/2]

◆ getData() [2/2]

◆ getLength()

◆ hash()

◆ indexOf() [1/2]

◆ indexOf() [2/2]

◆ isEmpty()

◆ isNull()

◆ lastIndexOf() [1/2]

◆ lastIndexOf() [2/2]

◆ length()

◆ operator!()

◆ operator+=() [1/4]

◆ operator+=() [2/4]

◆ operator+=() [3/4]

◆ operator+=() [4/4]

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ setLength()

Member Data Documentation

◆ END

◆ null