Struct Pool

pub struct Pool(/* private fields */);

Non-owning wrapper for an ngx_pool_t pointer, providing methods for working with memory pools.

See https://nginx.org/en/docs/dev/development_guide.html#pool

Implementations

impl Pool

pub unsafe fn from_ngx_pool(pool: *mut ngx_pool_t) -> Pool

Creates a new Pool from an ngx_pool_t pointer.

Safety

The caller must ensure that a valid ngx_pool_t pointer is provided, pointing to valid memory and non-null. A null argument will cause an assertion failure and panic.

pub fn create_buffer(&mut self, size: usize) -> Option<TemporaryBuffer>

Creates a buffer of the specified size in the memory pool.

Returns Some(TemporaryBuffer) if the buffer is successfully created, or None if allocation fails.

pub fn create_buffer_from_str(&mut self, str: &str) -> Option<TemporaryBuffer>

Creates a buffer from a string in the memory pool.

Returns Some(TemporaryBuffer) if the buffer is successfully created, or None if allocation fails.

pub fn create_buffer_from_static_str( &mut self, str: &'static str, ) -> Option<MemoryBuffer>

Creates a buffer from a static string in the memory pool.

Returns Some(MemoryBuffer) if the buffer is successfully created, or None if allocation fails.

pub fn alloc(&mut self, size: usize) -> *mut c_void

Allocates memory from the pool of the specified size. The resulting pointer is aligned to a platform word size.

Returns a raw pointer to the allocated memory.

pub fn alloc_type<T: Copy>(&mut self) -> *mut T

Allocates memory for a type from the pool. The resulting pointer is aligned to a platform word size.

Returns a typed pointer to the allocated memory.

pub fn calloc(&mut self, size: usize) -> *mut c_void

Allocates zeroed memory from the pool of the specified size. The resulting pointer is aligned to a platform word size.

Returns a raw pointer to the allocated memory.

pub fn calloc_type<T: Copy>(&mut self) -> *mut T

Allocates zeroed memory for a type from the pool. The resulting pointer is aligned to a platform word size.

Returns a typed pointer to the allocated memory.

pub fn alloc_unaligned(&mut self, size: usize) -> *mut c_void

Allocates unaligned memory from the pool of the specified size.

Returns a raw pointer to the allocated memory.

pub fn alloc_type_unaligned<T: Copy>(&mut self) -> *mut T

Allocates unaligned memory for a type from the pool.

Returns a typed pointer to the allocated memory.

pub fn allocate<T>(&mut self, value: T) -> *mut T

Allocates memory for a value of a specified type and adds a cleanup handler to the memory pool.

Returns a typed pointer to the allocated memory if successful, or a null pointer if allocation or cleanup handler addition fails.

Trait Implementations

impl Allocator for Pool

fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Attempts to allocate a block of memory.

unsafe fn deallocate(&self, ptr: NonNull<u8>, layout: Layout)

Deallocates the memory referenced by ptr.

fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError>

Behaves like allocate, but also ensures that the returned memory is zero-initialized.

unsafe fn grow( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to extend the memory block.

unsafe fn grow_zeroed( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Behaves like grow, but also ensures that the new contents are set to zero before being returned.

unsafe fn shrink( &self, ptr: NonNull<u8>, old_layout: Layout, new_layout: Layout, ) -> Result<NonNull<[u8]>, AllocError>

Attempts to shrink the memory block.

fn by_ref(&self) -> &Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Allocator.

impl AsMut<ngx_pool_s> for Pool

fn as_mut(&mut self) -> &mut ngx_pool_t

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<ngx_pool_s> for Pool

fn as_ref(&self) -> &ngx_pool_t

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Pool

fn clone(&self) -> Pool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Pool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.