[#secure_allocator]
= secure_allocator
:mrdocs:

Allocator that locks its contents from being paged out of memory and clears its contents before deletion.

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename T>
struct secure_allocator;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:secure_allocator/value_type.adoc[`value_type`] 
| The type of object this allocator allocates.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:secure_allocator/2constructor-02.adoc[`secure_allocator`]         [.small]#[constructor]#
| Constructors
| xref:secure_allocator/allocate.adoc[`allocate`] 
| Allocates locked memory for n objects from the locked pool.
| xref:secure_allocator/deallocate.adoc[`deallocate`] 
| Clears and returns locked memory previously obtained from allocate.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:operator_eq-06b.adoc[operator==]`
| Compares two secure allocators for equality; they are always equal since the allocator is stateless.
|===


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