Struct SlabPool

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

Non-owning wrapper for an ngx_slab_pool_t pointer, providing methods for working with shared memory slab pools.

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

Implementations

impl SlabPool

pub unsafe fn from_shm_zone(shm_zone: &ngx_shm_zone_t) -> Option<Self>

Creates a new SlabPool from an initialized shared zone.

Safety

Shared zones are initialized and safe to use:

• between the zone init callback and configuration reload in the master process
• during the whole lifetime of a worker process.

After the configuration reload (notably, in the cycle pool cleanup handlers), zone addresses in the old cycle may become unmapped.

pub fn lock(&self) -> LockedSlabPool

Locks the slab pool mutex.

Trait Implementations

impl Allocator for SlabPool

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_slab_pool_t> for SlabPool

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

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

impl AsRef<ngx_slab_pool_t> for SlabPool

fn as_ref(&self) -> &ngx_slab_pool_t

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

impl Clone for SlabPool

fn clone(&self) -> SlabPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SlabPool

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

Formats the value using the given formatter.

impl Send for SlabPool

impl Sync for SlabPool