Documentation of memory

( foonathan/memory)

memory_block Struct Reference

Detailed Description

A memory block.

It is defined by its starting address and size.

Member Functions

 memory_block () noexcept
 
 memory_block (void *mem, std::size_t size) noexcept
 
 memory_block (void *begin, void *end) noexcept
 
bool contains (const void *address) const noexcept
 

Constructors

§ memory_block() [1/3]

memory_block ( )
noexcept
Effects:
Creates an invalid memory block with starting address nullptr and size 0.

§ memory_block() [2/3]

memory_block ( void *  mem,
std::size_t  size 
)
noexcept
Effects:
Creates a memory block from a given starting address and size.

§ memory_block() [3/3]

memory_block ( void *  begin,
void *  end 
)
noexcept
Effects:
Creates a memory block from a [begin,end) range.

Member Functions

§ contains()

bool contains ( const void *  address) const
noexcept
Returns:
Whether or not a pointer is inside the memory.