- License
- Botan is released under the Simplified BSD License (see LICENSE.md)
DataSource
interface DataSourceImpl;
This class represents an abstract data source object.
abstract size_t read(ubyte* output, size_t length);
abstract const size_t peek(ubyte* output, size_t length, size_t peek_offset);
- Parameters
ubyte* output the ubyte array to write the output to size_t length the length of the ubyte array out size_t peek_offset the offset into the stream to read at - Returns
- length in bytes that was actually read and put into out
Read from the source but do not modify the internal offset. Consecutive calls to peek() will return portions of the source starting at the same position.
abstract const bool endOfData();
- Returns
- true if there is still data to read, false otherwise
Test whether the source still has data that can be read.
abstract const string id();
final size_t readByte(ref ubyte output);
- Parameters
ubyte output the ubyte to read to - Returns
- length in bytes that was actually read and put into out
Read one ubyte.
final const size_t peekByte(ref ubyte output);
- Parameters
ubyte output an output ubyte - Returns
- length in bytes that was actually read and put into out
Peek at one ubyte.
final size_t discardNext(size_t n);
- Parameters
size_t n the number of bytes to discard - Returns
- number of bytes actually discarded
Discard the next N bytes of the data
abstract const size_t getBytesRead();
- Returns
- number of bytes read so far.
class DataSourceMemoryImpl: botan.filters.data_src.DataSourceImpl;
This class represents a Memory-Based DataSource
this(in string input);
- Parameters
string input the string to read from
Construct a memory source that reads from a string
this(const(ubyte)* input, size_t length);
- Parameters
const(ubyte)* input the ubyte array to read from size_t length the length of the ubyte array
Construct a memory source that reads from a ubyte array
this(T, ALLOC)(auto ref const RefCounted!(Vector!(T, ALLOC), ALLOC) input);
- Parameters
RefCounted!(Vector!(T, ALLOC), ALLOC) input the MemoryRegion to read from
Construct a memory source that reads from a referenced vector
this(T, ALLOC)(auto ref const Vector!(T, ALLOC) input);
- Parameters
Vector!(T, ALLOC) input the MemoryRegion to read from
Construct a memory source that reads from a vector
this(T, ALLOC)(const Vector!(T, ALLOC)* input);
- Parameters
Vector!(T, ALLOC)* input the MemoryRegion to read from
Construct a memory source that reads from a vector*
class DataSourceStreamImpl: botan.filters.data_src.DataSourceImpl;
This class represents a Stream-Based DataSource.
this(in string path, bool use_binary = false);
- Parameters
string path the name of the file bool use_binary whether to treat the file as binary or not
Construct a Stream-Based DataSource from file