Crypto++ 8.4 Free C++ class library of cryptographic schemes

Public Member Functions | List of all members
GetBlock< T, B, A > Class Template Reference

Access a block of memory. More...

## Public Member Functions
| GetBlock (const void *block)
| Construct a GetBlock. More...
template<class U >
GetBlock< T, B, A > & | operator() (U &x)
| Access a block of memory. More...

## Detailed Description

### template<class T, class B, bool A = false>
class GetBlock< T, B, A >

Access a block of memory.

Template Parameters

  T | class or type
  B | enumeration indicating endianness
  A | flag indicating alignment

GetBlock() provides alternate read access to a block of memory. The enumeration B is BigEndian or LittleEndian. The flag A indicates if the memory block is aligned for class or type T. Repeatedly applying operator() results in advancing in the block of memory.

An example of reading two word32 values from a block of memory is shown below. `w1` will be `0x03020100` and `w1` will be `0x07060504`.

      word32 w1, w2;
      byte buffer[8] = {0,1,2,3,4,5,6,7};
      GetBlock<word32, LittleEndian> block(buffer);
      block(w1)(w2);

Definition at line 2508 of file misc.h.

## Constructor & Destructor Documentation

## ◆ GetBlock()

template<class T , class B , bool A = false>

GetBlock< T, B, A >::GetBlock | ( | const void * | block | ) |
| inline

Construct a GetBlock.

Parameters

  block | the memory block

Definition at line 2513 of file misc.h.

## Member Function Documentation

## ◆ operator()()

template<class T , class B , bool A = false>
template<class U >

GetBlock<T, B, A>& GetBlock< T, B, A >::operator() | ( | U & | x | ) |
| inline

Access a block of memory.

Template Parameters

  U | class or type

Parameters

  x | the value to read

Returns
  pointer to the remainder of the block after reading x

Definition at line 2521 of file misc.h.

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

- misc.h