Poco

template < class T >

class Buffer

Library: Foundation
Package: Core
Header: Poco/Buffer.h

Description

A very simple buffer class that allocates a buffer of a given type and size in the constructor and deallocates the buffer in the destructor.

This class is useful everywhere where a temporary buffer is needed.

Member Summary

Member Functions: append, assign, begin, capacity, clear, empty, end, operator !=, operator =, operator ==, operator [], resize, size, swap

Constructors

Buffer inline

Buffer(
    std::size_t capacity
);

Creates and allocates the Buffer.

Buffer inline

Buffer(
    const Buffer & other
);

Copy constructor.

Buffer inline

explicit Buffer(
    T * pMem,
    std::size_t length
);

Creates the Buffer. Length argument specifies the length of the supplied memory pointed to by pMem in the number of elements of type T. Supplied pointer is considered blank and not owned by Buffer, so in this case Buffer only acts as a wrapper around externally supplied (and lifetime-managed) memory.

Buffer inline

explicit Buffer(
    const T * pMem,
    std::size_t length
);

Creates and allocates the Buffer; copies the contents of the supplied memory into the buffer. Length argument specifies the length of the supplied memory pointed to by pMem in the number of elements of type T.

Destructor

~Buffer inline

~Buffer();

Destroys the Buffer.

Member Functions

append inline

void append(
    const T * buf,
    std::size_t sz
);

Resizes this buffer and appends the argument buffer.

append inline

void append(
    const Buffer & buf
);

Resizes this buffer and appends the argument buffer.

assign inline

void assign(
    const T * buf,
    std::size_t sz
);

Assigns the argument buffer to this buffer. If necessary, resizes the buffer.

begin inline

T * begin();

Returns a pointer to the beginning of the buffer.

begin inline

const T * begin() const;

Returns a pointer to the beginning of the buffer.

capacity inline

std::size_t capacity() const;

Returns the allocated memory size.

clear inline

void clear();

Sets the contents of the bufer to zero.

empty inline

bool empty() const;

Return true if buffer is empty.

end inline

T * end();

Returns a pointer to end of the buffer.

end inline

const T * end() const;

Returns a pointer to the end of the buffer.

operator != inline

bool operator != (
    const Buffer & other
) const;

Compare operator.

operator = inline

Buffer & operator = (
    const Buffer & other
);

Assignment operator.

operator == inline

bool operator == (
    const Buffer & other
) const;

Compare operator.

operator [] inline

T & operator[] (
    std::size_t index
);

operator [] inline

const T & operator[] (
    std::size_t index
) const;

resize inline

void resize(
    std::size_t newCapacity,
    bool preserveContent = true
);

Resizes the buffer capacity and size. If preserveContent is true, the content of the old buffer is copied over to the new buffer. The new capacity can be larger or smaller than the current one; if it is smaller, capacity will remain intact. Size will always be set to the new capacity.

Buffers only wrapping externally owned storage can not be resized. If resize is attempted on those, IllegalAccessException is thrown.

size inline

std::size_t size() const;

Returns the used size of the buffer.

swap inline

void swap(
    Buffer & other
);

Swaps the buffer with another one.