libdecaf
Public Member Functions | List of all members
decaf::FixedBuffer< Size > Class Template Reference

A fixed-size block. More...

Inheritance diagram for decaf::FixedBuffer< Size >:
decaf::Buffer decaf::Block decaf::FixedArrayBuffer< Size >

Public Member Functions

 FixedBuffer (Buffer b)
 Check a block's length. More...
 
 FixedBuffer (SecureBuffer &b)
 Check a block's length. More...
 
 FixedBuffer (uint8_t dat[Size], bool zero_on_destroy=false) DECAF_NOEXCEPT
 Explicitly pass a C buffer. More...
 
 operator FixedBlock< Size > () const DECAF_NOEXCEPT
 Cast to a FixedBlock. More...
 
- Public Member Functions inherited from decaf::Buffer
 Buffer () DECAF_NOEXCEPT
 Null init.
 
 Buffer (unsigned char *data, size_t size, bool zero_on_destroy=false) DECAF_NOEXCEPT
 Unowned init.
 
template<class alloc >
 Buffer (std::vector< unsigned char, alloc > &s)
 Block from std::vector.
 
const unsigned char * data () const DECAF_NOEXCEPT
 Get const data.
 
unsigned char * data () DECAF_NOEXCEPT
 Cast to unsigned char.
 
Buffer slice (size_t off, size_t length)
 Slice the buffer.
 
unsigned char & operator[] (size_t off)
 Subscript.
 
void assign (const Block b)
 Copy from another block.
 
- Public Member Functions inherited from decaf::Block
 Block ()
 Null initialization.
 
 Block (const char *data) DECAF_NOEXCEPT
 Init from C string.
 
 Block (const unsigned char *data, size_t size, bool zero_on_destroy=false) DECAF_NOEXCEPT
 Unowned init.
 
 Block (const std::string &s)
 Block from std::string.
 
template<class alloc >
 Block (const std::vector< unsigned char, alloc > &s)
 Block from std::vector.
 
const unsigned char * data () const DECAF_NOEXCEPT
 Get const data.
 
const unsigned char & operator[] (size_t off) const
 Subscript.
 
size_t size () const DECAF_NOEXCEPT
 Get the size.
 
std::string get_string () const
 Convert to C++ string.
 
Block slice (size_t off, size_t length) const
 Slice the buffer.
 
decaf_bool_t contents_equal (const Block &b) const DECAF_NOEXCEPT
 Content-wise comparison; constant-time if they are the same length. More...
 
 operator SecureBuffer () const
 Create new block from this.
 
void zeroize () DECAF_NOEXCEPT
 Securely set the buffer to 0. More...
 
void debug_print_hex (const char *name=NULL)
 Debugging print in hex.
 

Detailed Description

template<size_t Size>
class decaf::FixedBuffer< Size >

A fixed-size block.

Constructor & Destructor Documentation

◆ FixedBuffer() [1/3]

template<size_t Size>
decaf::FixedBuffer< Size >::FixedBuffer ( Buffer  b)
inline

Check a block's length.

◆ FixedBuffer() [2/3]

template<size_t Size>
decaf::FixedBuffer< Size >::FixedBuffer ( SecureBuffer b)
inline

Check a block's length.

◆ FixedBuffer() [3/3]

template<size_t Size>
decaf::FixedBuffer< Size >::FixedBuffer ( uint8_t  dat[Size],
bool  zero_on_destroy = false 
)
inlineexplicit

Explicitly pass a C buffer.

Member Function Documentation

◆ operator FixedBlock< Size >()

template<size_t Size>
decaf::FixedBuffer< Size >::operator FixedBlock< Size > ( ) const
inline

Cast to a FixedBlock.


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