WPILibC++ 2025.3.2
Loading...
Searching...
No Matches
wpi::memory::allocator_traits< memory_stack< BlockAllocator > > Class Template Reference

Specialization of the allocator_traits for memory_stack classes. More...

#include <wpi/memory/memory_stack.hpp>

Public Types

using allocator_type = memory_stack<BlockAllocator>
 
using is_stateful = std::true_type
 

Static Public Member Functions

static void * allocate_node (allocator_type &state, std::size_t size, std::size_t alignment)
 
static void * allocate_array (allocator_type &state, std::size_t count, std::size_t size, std::size_t alignment)
 
static std::size_t max_alignment (const allocator_type &) noexcept
 
static void deallocate_node (allocator_type &state, void *, std::size_t size, std::size_t) noexcept
 
static void deallocate_array (allocator_type &state, void *ptr, std::size_t count, std::size_t size, std::size_t alignment) noexcept
 
static std::size_t max_node_size (const allocator_type &state) noexcept
 
static std::size_t max_array_size (const allocator_type &state) noexcept
 

Detailed Description

template<class BlockAllocator>
class wpi::memory::allocator_traits< memory_stack< BlockAllocator > >

Specialization of the allocator_traits for memory_stack classes.

Note
It is not allowed to mix calls through the specialization and through the member functions, i.e. memory_stack::allocate() and this allocate_node().

Member Typedef Documentation

◆ allocator_type

template<class BlockAllocator >
using wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::allocator_type = memory_stack<BlockAllocator>

◆ is_stateful

template<class BlockAllocator >
using wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::is_stateful = std::true_type

Member Function Documentation

◆ allocate_array()

template<class BlockAllocator >
static void * wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::allocate_array ( allocator_type & state,
std::size_t count,
std::size_t size,
std::size_t alignment )
inlinestatic
Returns:
The result of memory_stack::allocate().

◆ allocate_node()

template<class BlockAllocator >
static void * wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::allocate_node ( allocator_type & state,
std::size_t size,
std::size_t alignment )
inlinestatic
Returns:
The result of memory_stack::allocate().

◆ deallocate_array()

template<class BlockAllocator >
static void wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::deallocate_array ( allocator_type & state,
void * ptr,
std::size_t count,
std::size_t size,
std::size_t alignment )
inlinestaticnoexcept

◆ deallocate_node()

template<class BlockAllocator >
static void wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::deallocate_node ( allocator_type & state,
void * ,
std::size_t size,
std::size_t  )
inlinestaticnoexcept
Effects:
Does nothing besides bookmarking for leak checking, if that is enabled. Actual deallocation can only be done via memory_stack::unwind().

◆ max_alignment()

template<class BlockAllocator >
static std::size_t wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::max_alignment ( const allocator_type & )
inlinestaticnoexcept
Returns:
The maximum possible value since there is no alignment restriction (except indirectly through memory_stack::next_capacity()).

◆ max_array_size()

template<class BlockAllocator >
static std::size_t wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::max_array_size ( const allocator_type & state)
inlinestaticnoexcept

◆ max_node_size()

template<class BlockAllocator >
static std::size_t wpi::memory::allocator_traits< memory_stack< BlockAllocator > >::max_node_size ( const allocator_type & state)
inlinestaticnoexcept
Returns:
The maximum size which is memory_stack::next_capacity().

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