|
Zen API
|
|
Zen API
|
Represents an in-memory stream.
Inheritance diagram for kMemory:Public Member Functions | |
| kStatus | kMemory_Allocate (kMemory memory, kSize initialCapacity) |
| Allocates an auto-sizing, internally-managed buffer for the memory stream. More... | |
| void * | kMemory_At (kMemory memory, kSize offset) |
| Returns a pointer to the memory buffer at the specified position. More... | |
| kStatus | kMemory_Attach (kMemory memory, void *buffer, kSize position, kSize length, kSize capacity) |
| Attaches the memory stream to an external, fixed-capacity buffer. More... | |
| kSize | kMemory_Capacity (kMemory memory) |
| Returns the current capacity of the memory buffer. More... | |
| kStatus | kMemory_Construct (kMemory *memory, kAlloc allocator) |
| Constructs a kMemory object. More... | |
| k64u | kMemory_Length (kMemory memory) |
| Returns the current length of the memory buffer. More... | |
| k64u | kMemory_Position (kMemory memory) |
| Returns the current position of the read/write pointer, relative to the beginning of the buffer. More... | |
| kStatus | kMemory_SetLength (kMemory memory, kSize length) |
| Sets the reported length of the memory buffer. More... | |
| kAlloc | kObject_Alloc (kObject object) |
| Gets the memory allocator associated with this object. More... | |
| kStatus | kObject_Clone (kObject *object, kObject source, kAlloc allocator) |
| Constructs a new object by copying an existing object, including any aggregated child elements. More... | |
| kStatus | kObject_Destroy (kObject object) |
| Destroys the object. More... | |
| kStatus | kObject_Dispose (kObject object) |
| Destroys the object and any aggregated child elements. More... | |
| kBool | kObject_Equals (kObject object, kObject other) |
| Determines whether the object is equal to another object. More... | |
| kSize | kObject_HashCode (kObject object) |
| Gets a hash code representing the state of this object. More... | |
| kBool | kObject_Is (kObject object, kType type) |
| Determines whether this object is an instance of the specified type. More... | |
| kBool | kObject_IsShared (kObject object) |
| Reports whether the object is currently shared (reference count greater than one). More... | |
| kStatus | kObject_SetPool (kObject object, kObjectPool pool) |
| Sets the object pool associated with this object. More... | |
| kStatus | kObject_Share (kObject object) |
| Increments the reference count associated with this object. More... | |
| kSize | kObject_Size (kObject object) |
| Estimates the memory consumed by this object, including any aggregated child elements. More... | |
| kType | kObject_Type (kObject object) |
| Returns the type of the object. More... | |
| k64u | kStream_BytesRead (kStream stream) |
| Reports the number of bytes read from this stream. More... | |
| k64u | kStream_BytesWritten (kStream stream) |
| Reports the number of bytes written to this stream. More... | |
| kStatus | kStream_ClearStats (kStream stream) |
| Clears stream statistics (e.g. More... | |
| kStatus | kStream_Copy (kStream stream, kStream source, kSize size) |
| Copies the specified number of bytes from one stream to another. More... | |
| kStatus | kStream_CopyEx (kStream stream, kStream source, kSize size, kCallbackFx progress, kPointer context) |
| Copies the specified number of bytes from one stream to another, with progress feedback. More... | |
| kStatus | kStream_Flush (kStream stream) |
| Flushes buffered writes to the underlying medium. More... | |
| kStatus | kStream_Read (kStream stream, void *buffer, kSize size) |
| Reads the specified number of bytes from the stream. More... | |
| kStatus | kStream_ReadSome (kStream stream, void *buffer, kSize minCount, kSize maxCount, kSize *bytesRead) |
| Reads up to the specified number of bytes from the stream. More... | |
| kStatus | kStream_Seek (kStream stream, k64s offset, kSeekOrigin origin) |
| Moves the read/write pointer to the specified location. More... | |
| kStatus | kStream_Write (kStream stream, const void *buffer, kSize size) |
| Writes the specified number of bytes to the stream. More... | |
Allocates an auto-sizing, internally-managed buffer for the memory stream.
| memory | kMemory object. |
| initialCapacity | Initial capacity of the buffer, in bytes. |
Returns a pointer to the memory buffer at the specified position.
| memory | kMemory object. |
| offset | Position of interest, in bytes. |
| kStatus kMemory_Attach | ( | kMemory | memory, |
| void * | buffer, | ||
| kSize | position, | ||
| kSize | length, | ||
| kSize | capacity | ||
| ) |
Attaches the memory stream to an external, fixed-capacity buffer.
| memory | kMemory object. |
| buffer | Data buffer. |
| position | Current read/write position, relative to start of buffer. |
| length | Length of valid data contained in the buffer, in bytes. |
| capacity | Total size of the buffer, in bytes. |
Returns the current capacity of the memory buffer.
| memory | kMemory object. |
Constructs a kMemory object.
By default, an auto-sizing, internally-managed buffer is used.
| memory | Destination for the constructed object handle. |
| allocator | Memory allocator (or kNULL for default). |
Returns the current length of the memory buffer.
| memory | kMemory object. |
Returns the current position of the read/write pointer, relative to the beginning of the buffer.
| memory | kMemory object. |
Sets the reported length of the memory buffer.
| memory | kMemory object. |
| length | Buffer length |
Gets the memory allocator associated with this object.
Most objects are constructed with an allocator, which is used to allocate the memory required by the object. Objects retain a reference to this allocator to enable further allocations and to free memory when the object is destroyed.
| object | Object. |
Constructs a new object by copying an existing object, including any aggregated child elements.
If the source object is an object collection (e.g. kArrayList<kString>), any aggregated child objects are also cloned. In this case, the kObject_Dispose method can be used to free the cloned collection and its associated elements.
This method will fail if the source object (or an aggregated child element) does not support cloning.
| object | Receives the constructed object. |
| source | Source object. |
| allocator | Memory allocator (or kNULL for default). |
Destroys the object.
The kObject_Destroy method destroys the object itself and any resources that are owned by the object. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Destroys the object and any aggregated child elements.
The kObject_Dispose method destroys the object itself, any resources that are owned by the object, and if the object represents a collection of objects, any child objects in the collection. See Object Destruction for more information.
When an object is destroyed (or disposed), its reference count is decremented. The object is only truly destroyed when the reference count reaches zero. See Reference Counting for more information.
| object | Object (or kNULL). |
Determines whether the object is equal to another object.
By default, objects are compared by reference; objects are considered equal if the given handles refer to the same object instance. However, some classes override the Equals method to provide a more meaningful comparison (e.g. kString).
| object | Object. |
| other | Object for comparison. |
Gets a hash code representing the state of this object.
By default, objects return a hash code based on the object handle value. However, some classes override the HashCode method to provide a more useful hash (e.g. kString).
| object | Object. |
Determines whether this object is an instance of the specified type.
This function compares the type of this object with the given type. An object is considered to be an instance of a given type if a) the type represents a class and this object inherits from (or instantiates) that class, or b) the type represents an interface and this object implements the interface.
| object | Object. |
| type | Type. |
Reports whether the object is currently shared (reference count greater than one).
Objects are initialized with a reference count of one. The kObject_Share method can be used to increment the reference count. The kObject_Destroy and kObject_Dispose methods decrease the reference count, and when the reference count reaches zero, the object is actually destroyed/disposed.
This method can be used to determine if the reference count of an object is currently greater than one.
This method is thread-safe.
| object | Object. |
|
inherited |
Sets the object pool associated with this object.
Object pools can be used to implement custom lifecycle management. If an object has an assigned pool, then the kObjectPool_Reclaim method will be called just prior to destruction, to provide an opportunity for the object to be reclaimed.
| object | Object. |
| pool | Pool object (or kNULL to clear the pool assignment). |
Increments the reference count associated with this object.
This method is thread-safe.
| object | Object. |
Estimates the memory consumed by this object, including any aggregated child elements.
This method can be optionally overridden by kObject-derived classes to report the amount of memory consumed by an object. The default implementation reports only the size of the class instance (additional allocations performed by the class are excluded).
| object | Object. |
Returns the type of the object.
Each object is an instance of a specific class type. The type handle returned by this function can be used to learn about the class.
| object | Object. |
Reports the number of bytes read from this stream.
| stream | Stream object. |
Reports the number of bytes written to this stream.
| stream | Stream object. |
Clears stream statistics (e.g.
BytesRead, BytesWritten).
| stream | Stream object. |
Copies the specified number of bytes from one stream to another.
| stream | Destination stream. |
| source | Source stream. |
| size | Count of bytes to be copied. |
|
inherited |
Copies the specified number of bytes from one stream to another, with progress feedback.
The specified callback will be invoked to provide feedback on the progress of the operation. The callback 'args' parameter will receive a k32u value representing the percentage completed. The callback is guaranteed to be called at least once if the operation is successful, with a progress value of 100%.
| stream | Destination stream. |
| source | Source stream. |
| size | Count of bytes to be copied. |
| progress | Optional progress callback (can be kNULL). |
| context | Callback context. |
Flushes buffered writes to the underlying medium.
| stream | Stream object. |
Reads the specified number of bytes from the stream.
| stream | Stream object. |
| buffer | Destination for bytes that are read. |
| size | Count of bytes to read. |
|
inherited |
Reads up to the specified number of bytes from the stream.
| stream | Stream object. |
| buffer | Destination for bytes that are read. |
| minCount | Minimum count of bytes to read. |
| maxCount | Maximum count of bytes to read. |
| bytesRead | Receives count of bytes read. |
|
inherited |
Moves the read/write pointer to the specified location.
| stream | Stream object. |
| offset | Offset by which to adjust the read/write pointer. |
| origin | Origin to which movement is relative (i.e. begin, current, end). |
Writes the specified number of bytes to the stream.
| stream | Stream object. |
| buffer | Bytes to be written to the stream. |
| size | Count of bytes to be written. |
