#include <Stream.h>
◆ ~InputStream()
Aws::Crt::Io::InputStream::~InputStream |
( |
| ) |
|
|
virtual |
◆ InputStream() [1/3]
Aws::Crt::Io::InputStream::InputStream |
( |
const InputStream & |
| ) |
|
|
delete |
◆ InputStream() [2/3]
Aws::Crt::Io::InputStream::InputStream |
( |
InputStream && |
| ) |
|
|
delete |
◆ InputStream() [3/3]
◆ GetLength()
bool Aws::Crt::Io::InputStream::GetLength |
( |
int64_t & |
length | ) |
|
|
inline |
Gets the stream's length. Some streams may not be able to answer this.
- Parameters
-
length | output parameter for the length of the stream |
- Returns
- success/failure
◆ GetLengthImpl()
virtual int64_t Aws::Crt::Io::InputStream::GetLengthImpl |
( |
| ) |
const |
|
protectedpure virtualnoexcept |
◆ GetStatus()
bool Aws::Crt::Io::InputStream::GetStatus |
( |
StreamStatus & |
status | ) |
|
|
inline |
Gets the stream's current status
- Parameters
-
status | output parameter for the stream's status |
- Returns
- success/failure
◆ GetStatusImpl()
virtual StreamStatus Aws::Crt::Io::InputStream::GetStatusImpl |
( |
| ) |
const |
|
protectedpure virtualnoexcept |
◆ IsValid()
virtual bool Aws::Crt::Io::InputStream::IsValid |
( |
| ) |
const |
|
pure virtualnoexcept |
◆ operator bool()
Aws::Crt::Io::InputStream::operator bool |
( |
| ) |
const |
|
inlineexplicitnoexcept |
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ PeekImpl()
virtual int64_t Aws::Crt::Io::InputStream::PeekImpl |
( |
| ) |
const |
|
protectedpure virtualnoexcept |
◆ Read()
bool Aws::Crt::Io::InputStream::Read |
( |
ByteBuf & |
dest | ) |
|
|
inline |
Reads data from the stream into a buffer
- Parameters
-
dest | buffer to add the read data into |
- Returns
- success/failure
◆ ReadImpl()
virtual bool Aws::Crt::Io::InputStream::ReadImpl |
( |
ByteBuf & |
buffer | ) |
|
|
protectedpure virtualnoexcept |
◆ ReadSomeImpl()
virtual bool Aws::Crt::Io::InputStream::ReadSomeImpl |
( |
ByteBuf & |
buffer | ) |
|
|
protectedpure virtualnoexcept |
◆ Seek()
bool Aws::Crt::Io::InputStream::Seek |
( |
int64_t |
offset, |
|
|
StreamSeekBasis |
seekBasis |
|
) |
| |
|
inline |
Moves the head of the stream to a new location
- Parameters
-
offset | how far to move, in bytes |
seekBasis | what direction to move the head of stream |
- Returns
- success/failure
◆ SeekImpl()
virtual bool Aws::Crt::Io::InputStream::SeekImpl |
( |
int64_t |
offset, |
|
|
StreamSeekBasis |
seekBasis |
|
) |
| |
|
protectedpure virtualnoexcept |
Seek's the stream to seekBasis based offset bytes.
It is expected, that if seeking to the beginning of a stream, all error's are cleared if possible.
- Returns
- true on success, false otherwise. You SHOULD raise an error via aws_raise_error() if a failure occurs.
◆ m_allocator
Allocator* Aws::Crt::Io::InputStream::m_allocator |
|
protected |
◆ m_underlying_stream
aws_input_stream Aws::Crt::Io::InputStream::m_underlying_stream |
|
protected |
The documentation for this class was generated from the following files: