- License
- Botan is released under the Simplified BSD License (see LICENSE.md)
Buffered Computation
interface BufferedComputation;
This class represents any kind of computation which uses an internal state, such as hash functions or MACs
final void update(in ubyte[] input);
- Parameters
ubyte[] input the input to process as a ubyte array
Add new input to process.
final void update(const(ubyte)* input, size_t length);
- Parameters
const(ubyte)* input the input to process as a ubyte array size_t length of param in in bytes
Add new input to process.
final void update(T, ALLOC)(auto ref const RefCounted!(Vector!(T, ALLOC)) input);
- Parameters
RefCounted!(Vector!(T, ALLOC)) input the input to process as a reference type
Add new input to process.
final void update(T, ALLOC)(auto ref const Vector!(T, ALLOC) input);
- Parameters
Vector!(T, ALLOC) input the input to process as a Vector
Add new input to process.
final void updateBigEndian(T)(in T input);
- Parameters
T input the value
Add an integer in big-endian order
final void update(in string str);
- Parameters
string str The input to process as a string. - Notes:
- Will be interpreted as a ubyte array based on the strings encoding.
Add new input to process.
final void update(ubyte input);
- Parameters
ubyte input the ubyte to process
Process a single ubyte.
final void flushInto(ref ubyte[] output);
- Parameters
ubyte[] output The ubyte array to be filled with the result. - Notes:
- Must be of length outputLength()
Complete the computation and retrieve the final result.
final void flushInto(ubyte* output);
- Parameters
ubyte* output The ubyte array to be filled with the result. - Notes:
- Must be of length outputLength()
Complete the computation and retrieve the final result.
final SecureVector!ubyte finished();
- Returns
- SecureVector holding the result
Complete the computation and retrieve the final result.
final SecureVector!ubyte process(in ubyte[] input);
- Parameters
ubyte[] input the input to process as a ubyte array - Returns
- The result of the call to finished()
Update and finalize computation. Does the same as calling update() and finished() consecutively.
final SecureVector!ubyte process(const(ubyte)* input, size_t length);
- Parameters
const(ubyte)* input the input to process as a ubyte array size_t length the length of the ubyte array - Returns
- The result of the call to finished()
Update and finalize computation. Does the same as calling update() and finished() consecutively.
final SecureVector!ubyte process(ALLOC)(auto ref const RefCounted!(Vector!(ubyte, ALLOC), ALLOC) input);
- Parameters
RefCounted!(Vector!(ubyte, ALLOC), ALLOC) input the input to process - Returns
- The result of the call to finished()
Update and finalize computation. Does the same as calling update() and finished() consecutively.
final SecureVector!ubyte process(ALLOC)(auto ref const Vector!(ubyte, ALLOC) input);
- Parameters
Vector!(ubyte, ALLOC) input the input to process - Returns
- The result of the call to finished()
Update and finalize computation. Does the same as calling update() and finished() consecutively.
final SecureVector!ubyte process(in string input);
- Parameters
string input the input to process as a string - Returns
- The result of the call to finished()
Update and finalize computation. Does the same as calling update() and finished() consecutively.
abstract const @property size_t outputLength();
- Returns
- Length of the output of this function in bytes
protected abstract void addData(const(ubyte)* input, size_t length);
- Parameters
const(ubyte)* input is an input buffer size_t length is the length of input in bytes
Add more data to the computation
protected abstract void finalResult(ubyte* output);
- Parameters
ubyte* output An output buffer of size outputLength()
Write the final output to out