Grok  7.6.6
Public Member Functions | List of all members
grk::IBufferedStream Struct Referenceabstract

#include <IBufferedStream.h>

Inheritance diagram for grk::IBufferedStream:
grk::BufferedStream

Public Member Functions

virtual ~IBufferedStream ()
 
virtual bool write_byte (uint8_t value)=0
 
virtual bool write_short (uint16_t value)=0
 
virtual bool write_24 (uint32_t value)=0
 
virtual bool write_int (uint32_t value)=0
 
virtual size_t write_bytes (const uint8_t *p_buffer, size_t p_size)=0
 Write bytes to the stream. More...
 
virtual bool flush ()=0
 Flush write stream to disk. More...
 
virtual bool skip (int64_t p_size)=0
 Skip bytes in stream, forward or reverse. More...
 
virtual uint64_t tell (void)=0
 Tell byte offset in stream (similar to ftell). More...
 
virtual uint64_t get_number_byte_left (void)=0
 Get number of bytes left before end of the stream. More...
 
virtual bool seek (uint64_t offset)=0
 Seek to absolute offset in stream. More...
 
virtual bool has_seek ()=0
 Check if stream is seekable. More...
 

Constructor & Destructor Documentation

◆ ~IBufferedStream()

virtual grk::IBufferedStream::~IBufferedStream ( )
inlinevirtual

Member Function Documentation

◆ flush()

virtual bool grk::IBufferedStream::flush ( )
pure virtual

Flush write stream to disk.

Returns
true if the data could be flushed, otherwise false.

Implemented in grk::BufferedStream.

◆ get_number_byte_left()

virtual uint64_t grk::IBufferedStream::get_number_byte_left ( void  )
pure virtual

Get number of bytes left before end of the stream.

Returns
Number of bytes left.

Implemented in grk::BufferedStream.

◆ has_seek()

virtual bool grk::IBufferedStream::has_seek ( )
pure virtual

Check if stream is seekable.

(A stdin/stdout stream is not seekable).

Returns
true if stream is seekable, otherwise false

Implemented in grk::BufferedStream.

◆ seek()

virtual bool grk::IBufferedStream::seek ( uint64_t  offset)
pure virtual

Seek to absolute offset in stream.

Parameters
offsetabsolute offset in stream
Returns
true if successful, otherwise false.

Implemented in grk::BufferedStream.

◆ skip()

virtual bool grk::IBufferedStream::skip ( int64_t  p_size)
pure virtual

Skip bytes in stream, forward or reverse.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false.

Implemented in grk::BufferedStream.

◆ tell()

virtual uint64_t grk::IBufferedStream::tell ( void  )
pure virtual

Tell byte offset in stream (similar to ftell).

Returns
current position of the stream.

Implemented in grk::BufferedStream.

◆ write_24()

virtual bool grk::IBufferedStream::write_24 ( uint32_t  value)
pure virtual

Implemented in grk::BufferedStream.

◆ write_byte()

virtual bool grk::IBufferedStream::write_byte ( uint8_t  value)
pure virtual

Implemented in grk::BufferedStream.

Referenced by grk::BitIO::byteout_stream().

◆ write_bytes()

virtual size_t grk::IBufferedStream::write_bytes ( const uint8_t *  p_buffer,
size_t  p_size 
)
pure virtual

Write bytes to the stream.

Parameters
p_bufferpointer to the data buffer to be written.
p_sizenumber of bytes to write.
Returns
the number of bytes written, or -1 if an error occurred.

Implemented in grk::BufferedStream.

◆ write_int()

virtual bool grk::IBufferedStream::write_int ( uint32_t  value)
pure virtual

Implemented in grk::BufferedStream.

◆ write_short()

virtual bool grk::IBufferedStream::write_short ( uint16_t  value)
pure virtual

Implemented in grk::BufferedStream.


The documentation for this struct was generated from the following file: