10 #ifndef K_API_STREAM_H
11 #define K_API_STREAM_H
14 #include <kApi/Io/kStream.x.h>
41 if ((obj->readEnd - obj->readBegin) < size)
43 return xkStream_VTable(stream)->VReadSomeImpl(stream, buffer, size, size,
kNULL);
46 kMemCopy(buffer, &obj->readBuffer[obj->readBegin], size);
47 obj->readBegin += size;
66 kSize bufferAvailable = obj->readEnd - obj->readBegin;
68 if (bufferAvailable < minCount)
70 return xkStream_VTable(stream)->VReadSomeImpl(stream, buffer, minCount, maxCount, bytesRead);
76 kMemCopy(buffer, &obj->readBuffer[obj->readBegin], size);
77 obj->readBegin += size;
101 if ((obj->writeEnd - obj->writeBegin) < size)
103 return xkStream_VTable(stream)->VWriteImpl(stream, buffer, size);
106 kMemCopy(&obj->writeBuffer[obj->writeBegin], buffer, size);
107 obj->writeBegin += size;
164 return xkStream_VTable(stream)->VSeek(stream, offset, origin);
176 return xkStream_VTable(stream)->VFlush(stream);
192 if ((obj->readEnd - obj->readBegin) > 0)
197 return xkStream_VTable(stream)->VFill(stream);
211 return obj->bytesRead - (
k64u)(obj->readEnd - obj->readBegin);
225 return obj->bytesWritten + (
k64u)obj->writeBegin;
240 obj->bytesWritten = 0;
266 obj->readBuffer =
kNULL;
267 obj->readCapacity = 0;
270 obj->writeBuffer =
kNULL;
271 obj->writeCapacity = 0;
275 obj->bytesWritten = 0;
319 kCheck(xkStream_VTable(stream)->VReadImpl(stream, buffer, minCount));
323 *bytesRead = minCount;
kStatus kObject_VRelease(kObject object)
Protected virtual method that deallocates any resources owned by the object.
Definition: kObject.h:448
kStatus kStream_VFlush(kStream stream)
Protected virtual method that flushes buffered writes to the underlying medium.
Definition: kStream.h:370
k64u kStream_BytesRead(kStream stream)
Reports the number of bytes read from this stream.
Definition: kStream.h:207
#define kMin_(A, B)
Returns the minimum of two numbers.
Definition: kApiDef.h:1840
Represents a 64-bit unsigned integer.
Represents a void pointer.
#define kIsNull(POINTER)
Tests for equality with null pointer.
Definition: kApiDef.h:339
kStatus kStream_Copy(kStream stream, kStream source, kSize size)
Copies the specified number of bytes from one stream to another.
Definition: kStream.h:121
kStatus kStream_Flush(kStream stream)
Flushes buffered writes to the underlying medium.
Definition: kStream.h:174
kStatus kStream_VRelease(kStream stream)
Protected virtual method that deallocates any resources owned by the object.
Definition: kStream.h:288
kStatus kObject_Init(kObject object, kType type, kAlloc alloc)
Protected method called by derived classes to initialize the kObject base class.
Definition: kObject.h:359
Represents an unsigned integer that can store a pointer address.
Abstract base class for memory allocator types.
#define kCheck(EXPRESSION)
Executes a return statement if the given expression is not kOK.
Definition: kApiDef.h:559
kStatus kStream_ReadSome(kStream stream, void *buffer, kSize minCount, kSize maxCount, kSize *bytesRead)
Reads up to the specified number of bytes from the stream.
Definition: kStream.h:63
kStatus kStream_VWriteImpl(kStream stream, const void *buffer, kSize size)
Protected virtual method that writes the specified number of bytes to the stream. ...
Definition: kStream.h:340
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:26
kStatus kStream_Seek(kStream stream, k64s offset, kSeekOrigin origin)
Moves the read/write pointer to the specified location, if supported by the underlying stream...
Definition: kStream.h:162
kStatus kMemCopy(void *dest, const void *src, kSize size)
Copies memory from a source buffer to a non-overlapping destination.
Represents a stream seek origin.
kStatus kStream_VReadSomeImpl(kStream stream, void *buffer, kSize minCount, kSize maxCount, kSize *bytesRead)
Protected virtual method that deallocates any resources owned by the object.
Definition: kStream.h:315
kStatus kStream_VFill(kStream stream)
Protected virtual method that partially fills the read buffer with bytes from the underlying medium...
Definition: kStream.h:384
#define kObj(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from a type-checked object handle...
Definition: kApiDef.h:2921
kStatus kStream_CopyAll(kStream stream, kStream source)
Copies all bytes from one stream to another.
kStatus kStream_VSeek(kStream stream, k64s offset, kSeekOrigin origin)
Protected virtual method that moves the read/write pointer to the specified location.
Definition: kStream.h:356
#define kObjR(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from an object handle, without type-checking.
Definition: kApiDef.h:2933
#define kCheckState(EXPRESSION)
Executes a return statement if the given expression is not kTRUE.
Definition: kApiDef.h:593
Core Zen type declarations.
Represents an I/O stream.
kStatus kStream_Fill(kStream stream)
Partially fills the read buffer with bytes from the underlying medium.
Definition: kStream.h:186
kStatus(kCall * kCallbackFx)(kPointer receiver, kPointer sender, void *args)
Callback signature for a generic event handler.
Definition: kApiDef.h:1735
Represents a 64-bit signed integer.
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.
#define kERROR_UNIMPLEMENTED
Feature not implemented.
Definition: kApiDef.h:492
k64u kStream_BytesWritten(kStream stream)
Reports the number of bytes written to this stream.
Definition: kStream.h:221
Represents metadata about a type (class, interface, or value).
#define kOK
Operation successful.
Definition: kApiDef.h:513
Represents an error code.
kStatus kStream_Write(kStream stream, const void *buffer, kSize size)
Writes the specified number of bytes to the stream.
Definition: kStream.h:97
#define kNULL
Null pointer.
Definition: kApiDef.h:267
kStatus kStream_Init(kStream stream, kType type, kAlloc allocator)
Protected method called by derived classes to initialize the kStream base class.
Definition: kStream.h:260
kStatus kStream_Read(kStream stream, void *buffer, kSize size)
Reads the specified number of bytes from the stream.
Definition: kStream.h:37
kStatus kStream_ClearStats(kStream stream)
Clears stream statistics (e.g.
Definition: kStream.h:235