basis::byte_array Class Reference
A very common template for a dynamic array of bytes. More...
#include <byte_array.h>
Inheritance diagram for basis::byte_array:
Collaboration diagram for basis::byte_array:
Public Member Functions | |
| byte_array (int number=0, const abyte *initial_contents=NULL_POINTER) | |
| constructs an array of "number" bytes from "initial_contents". More... | |
| byte_array (const byte_array &to_copy) | |
| constructs an array bytes by copying the "to_copy" array. More... | |
| byte_array (const array< abyte > &to_copy) | |
| constructs an array bytes by copying the "to_copy" array. More... | |
| virtual | ~byte_array () |
| DEFINE_CLASS_NAME ("byte_array") | |
| returns an array of zero bytes. More... | |
| virtual bool | equal_to (const equalizable &s2) const |
| virtual bool | less_than (const orderable &s2) const |
| int | comparator (const byte_array &s2) const |
 Public Member Functions inherited from basis::array< abyte > | |
| DEFINE_CLASS_NAME ("array") | |
| array (int number=0, const abyte *init=NULL_POINTER, int flags=EXPONENTIAL_GROWTH|FLUSH_INVISIBLE) | |
| Constructs an array with room for "number" objects. More... | |
| array (const array< abyte > ©_from) | |
| copies the contents & sizing information from "copy_from". More... | |
| virtual | ~array () |
| destroys the memory allocated for the objects. More... | |
| void | reset (int number=0, const abyte *initial_contents=NULL_POINTER) |
| Resizes this array and sets the contents from an array of contents. More... | |
| array & | operator= (const array< abyte > ©_from) |
| Copies the array in "copy_from" into this. More... | |
| int | length () const |
| Returns the current reported length of the allocated C array. More... | |
| int | last () const |
| Returns the last valid element in the array. More... | |
| int | flags () const |
| Provides the raw flags value, without interpreting what it means. More... | |
| bool | exponential () const |
| Returns true if this allocator will grow exponentially on resize. More... | |
| bool | simple () const |
| Reports whether the templated object is a simple type or not. More... | |
| const abyte & | get (int index) const |
| Accesses individual objects stored in "this" at the "index" position. More... | |
| abyte & | use (int index) |
| A non-constant version of get(); the returned object can be modified. More... | |
| const abyte & | operator[] (int index) const |
| Synonym for get that provides the expected array indexing syntax. More... | |
| abyte & | operator[] (int index) |
| Synonym for use that provides the expected array indexing syntax. More... | |
| outcome | put (int index, const abyte &to_put) |
| Stores an object at the index "index" in the array. More... | |
| array | concatenation (const array &to_concatenate) const |
| Returns the concatenation of "this" and the array "to_concatenate". More... | |
| array | concatenation (const abyte &to_concatenate) const |
| Returns the concatenation of "this" and the object "to_concatenate". More... | |
| array & | concatenate (const array &to_concatenate) |
| Appends the array "to_concatenate" onto "this" and returns "this". More... | |
| array & | concatenate (const abyte &to_concatenate) |
| Appends the object "to_concatenate" onto "this" and returns "this". More... | |
| array & | concatenate (const abyte *to_concatenate, int length) |
| Concatenates a C-array "to_concatenate" onto "this" and returns "this". More... | |
| array | operator+ (const array &to_cat) const |
| Synonym for concatenation. More... | |
| array | operator+ (const abyte &to_concatenate) const |
| Synonym for concatenation. More... | |
| array & | operator+= (const array &to_concatenate) |
| Synonym for concatenate that modifies "this". More... | |
| array & | operator+= (const abyte &to_concatenate) |
| Synonym for concatenate that modifies "this". More... | |
| const abyte * | observe () const |
| Returns a pointer to the underlying C array of data. More... | |
| abyte * | access () |
| A non-constant access of the underlying C-array. BE REALLY CAREFUL. More... | |
| void | swap_contents (array< abyte > &other) |
| Exchanges the contents of "this" and "other". More... | |
| void | snarf (array &new_contents) |
| Drops "this" array's contents into the dustbin and uses "new_contents". More... | |
| array | subarray (int start, int end) const |
| Returns the array segment between the indices "start" and "end". More... | |
| outcome | insert (int index, int new_indices) |
| Adds "new_indices" new positions for objects into the array at "index". More... | |
| outcome | overwrite (int index, const array &write_with, int count=-1) |
| Stores the array "write_with" into the current array at the "index". More... | |
| outcome | stuff (int length, abyte *to_stuff) const |
| Copies at most "length" elements from this into the array "to_stuff". More... | |
| outcome | resize (int new_size, how_to_copy way=NEW_AT_END) |
| Changes the size of the C array to "new_size". More... | |
| outcome | zap (int start, int end) |
| Deletes from "this" the objects inclusively between "start" and "end". More... | |
| outcome | shrink () |
| Cuts loose any allocated space that is beyond the real length. More... | |
| outcome | retrain (int new_size, const abyte *to_copy) |
| Resizes the C array and stuffs it with the contents in "to_copy". More... | |
| void | shift_data (shift_directions where) |
| The valid portion of the array is moved to the left or right. More... | |
| int | internal_real_length () const |
| Gritty Internal: the real allocated length. More... | |
| int | internal_offset () const |
| Gritty Internal: the offset from real start to stored data. More... | |
| const abyte * | internal_block_start () const |
| Gritty Internal: constant peek at the real allocated pointer. More... | |
| abyte * | internal_block_start () |
| Gritty Internal: the real allocated pointer made accessible. More... | |
| abyte *const * | internal_offset_mem () const |
| Gritty Internal: the start of the actual stored data. More... | |
| Public Member Functions inherited from basis::orderable | |
| virtual bool | operator< (const orderable &s2) const |
| the virtual method for object ordering. More... | |
| Public Member Functions inherited from basis::equalizable | |
| virtual bool | operator== (const equalizable &s2) const |
| the virtual method for object equality. More... | |
Static Public Member Functions | |
| static const byte_array & | empty_array () |
Additional Inherited Members | |
| Public Types inherited from basis::array< abyte > | |
| enum | specialc_flags |
| the flags specify how the array treats its contents and its length. More... | |
| enum | how_to_copy |
| enum | shift_directions |
Detailed Description
A very common template for a dynamic array of bytes.
byte_array provides a simple wrapper around array<byte>, but with the exponential growth and simple copy modes automatically enabled. Note that it is almost always best to forward declare byte_arrays in ones own headers rather than including this header.
Definition at line 35 of file byte_array.h.
Constructor & Destructor Documentation
◆ byte_array() [1/3]
|
inline |
constructs an array of "number" bytes from "initial_contents".
Definition at line 38 of file byte_array.h.
◆ byte_array() [2/3]
|
inline |
constructs an array bytes by copying the "to_copy" array.
Definition at line 42 of file byte_array.h.
◆ byte_array() [3/3]
constructs an array bytes by copying the "to_copy" array.
Definition at line 46 of file byte_array.h.
◆ ~byte_array()
|
inlinevirtual |
Definition at line 49 of file byte_array.h.
Member Function Documentation
◆ comparator()
|
inline |
Definition at line 72 of file byte_array.h.
References basis::array< abyte >::length(), basis::array< contents >::observe(), and basis::array< abyte >::observe().
Referenced by equal_to(), and less_than().
◆ DEFINE_CLASS_NAME()
| basis::byte_array::DEFINE_CLASS_NAME | ( | "byte_array" | ) |
returns an array of zero bytes.
note that this is implemented in the opsystem library to avoid bad issues with static objects mixed into multiple dlls from a static library.
◆ empty_array()
|
inlinestatic |
Definition at line 57 of file byte_array.h.
◆ equal_to()
|
inlinevirtual |
◆ less_than()
|
inlinevirtual |
The documentation for this class was generated from the following file:
- /opt/feistymeow.org/feisty_meow/nucleus/library/basis/byte_array.h
