[#PoolAllocator-0e]
= PoolAllocator
:mrdocs:

Forwards all allocations/deallocations to the PoolResource.

== Synopsis

Declared in `<support/allocators/pool.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class T,
    std::size_t MAX_BLOCK_SIZE_BYTES,
    std::size_t ALIGN_BYTES = alignof(T)>
class PoolAllocator;
----

== Types

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/rebind.adoc[`rebind`] 
| The rebind struct here is mandatory because we use non type template arguments for PoolAllocator. See https://en.cppreference.com/w/cpp/named_req/Allocator#cite_note‐2
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/ResourceType.adoc[`ResourceType`] 
| The pool resource type that backs this allocator.
| xref:PoolAllocator-0e/value_type.adoc[`value_type`] 
| The type of object this allocator allocates.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-0e/2constructor-0e.adoc[`PoolAllocator`]         [.small]#[constructor]#
| Constructors
| xref:PoolAllocator-0e/operator_assign.adoc[`operator=`] 
| Copy assignment; shares the same backing resource.
| xref:PoolAllocator-0e/allocate.adoc[`allocate`] 
| Forwards each call to the resource.
| xref:PoolAllocator-0e/deallocate.adoc[`deallocate`] 
| Forwards each call to the resource.
| xref:PoolAllocator-0e/resource.adoc[`resource`] 
| Access the backing pool resource.
|===


== Specializations

[cols="1,4"]
|===
| Name| Description
| xref:PoolAllocator-04.adoc[`PoolAllocator<pair<COutPoint const, CCoinsCacheEntry>, 152>`] 
| Forwards all allocations/deallocations to the PoolResource.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `PoolAllocator`
| Forwards all allocations/deallocations to the PoolResource.
|===

== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:operator_eq-019.adoc[`operator==`]
| Compares two pool allocators for equality.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#