Skip to main content

Allocator

Struct Allocator 

Source
pub struct Allocator<'amx> { /* private fields */ }
Expand description

AMX heap allocator with automatic release (RAII).

Captures the value of amx.hea at creation time and restores it on Drop, freeing everything allocated by the Allocator in a single operation. Do not use multiple nested Allocators — each one restores to a different heap point.

Implementations§

Source§

impl<'amx> Allocator<'amx>

Source

pub fn allot<T>(&self, init_value: T) -> Result<Ref<'_, T>, AmxError>
where T: AmxPrimitive,

Allocates a single cell on the heap and initializes it with init_value.

§Errors

AmxError::Memory if the VM heap is exhausted.

Source

pub fn allot_buffer(&self, size: usize) -> Result<Buffer<'_>, AmxError>

Allocates size cells on the heap and returns a Buffer covering that region.

§Errors

AmxError::Memory if the VM heap is exhausted or if size exceeds i32::MAX.

Source

pub fn allot_array<T>(&self, array: &[T]) -> Result<Buffer<'_>, AmxError>
where T: AmxCell<'amx> + AmxPrimitive,

Allocates space for array.len() cells and copies the content (AmxCell::as_cell).

§Errors

AmxError::Memory if the VM heap is exhausted.

Source

pub fn allot_string(&self, string: &str) -> Result<AmxString<'_>, AmxError>

Allocates space for a string and copies string (configured encoding), adding the 0 terminator at the end.

§Errors

AmxError::Memory if the VM heap is exhausted.

Trait Implementations§

Source§

impl Drop for Allocator<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'amx> !Send for Allocator<'amx>

§

impl<'amx> !Sync for Allocator<'amx>

§

impl<'amx> Freeze for Allocator<'amx>

§

impl<'amx> RefUnwindSafe for Allocator<'amx>

§

impl<'amx> Unpin for Allocator<'amx>

§

impl<'amx> UnsafeUnpin for Allocator<'amx>

§

impl<'amx> UnwindSafe for Allocator<'amx>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.