Struct itron_solid_fmp3::memorypool::MemoryPoolRef

pub struct MemoryPoolRef<'a> { /* fields omitted */ }

This is supported on crate feature unstable only.

A borrowed reference to a memory pool.

Implementations

impl MemoryPoolRef<'_>

Object ID conversion

pub const unsafe fn from_raw_nonnull(id: NonNullID) -> Self

Construct a MemoryPoolRef from a raw object ID.

Safety

See Object ID Wrappers.

pub const fn as_raw(self) -> ID

Get the raw object ID.

pub const fn as_raw_nonnull(self) -> NonNullID

Get the raw object ID as abi::NonNullID.

impl MemoryPoolRef<'_>

Management

pub unsafe fn delete(self) -> Result<(), Error<DeleteError>>

This is supported on crate feature dcre only.

del_mpf: Delete the memory pool.

Safety

See Object ID Wrappers.

pub fn info(self) -> Result<Info, Error<InfoError>>

ref_mpf: Get the memory pool’s general information.

impl MemoryPoolRef<'_>

Memory Pool Operations

pub fn get(self) -> Result<Block, Error<GetError>>

get_mpf: Acquire a memory block. Blocks the current task if no free memory blocks are available.

pub fn get_timeout(self, tmo: Timeout) -> Result<Block, Error<GetTimeoutError>>

tget_mpf: Acquire a memory block. Blocks the current task with timeout if no free memory blocks are available.

pub fn try_get(self) -> Result<Block, Error<TryGetError>>

pget_mpf: Acquire a memory block. Fails and returns immediately if no free memory blocks are available.

pub fn release(self, block: Block) -> Result<(), Error<ReleaseError>>

rel_mpf: Return a memory block to the memory pool.

pub fn initialize(self) -> Result<(), Error<InitializeError>>

ini_mpf: Initialize the memory pool.

Trait Implementations

impl<'a> Clone for MemoryPoolRef<'a>

fn clone(&self) -> MemoryPoolRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryPoolRef<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq<MemoryPoolRef<'a>> for MemoryPoolRef<'a>

fn eq(&self, other: &MemoryPoolRef<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MemoryPoolRef<'a>) -> bool

This method tests for !=.

impl<'a> Copy for MemoryPoolRef<'a>

impl<'a> Eq for MemoryPoolRef<'a>

impl<'a> StructuralEq for MemoryPoolRef<'a>

impl<'a> StructuralPartialEq for MemoryPoolRef<'a>