Enum fuchsia_audio_codec::sysmem_allocator::SysmemAllocation

pub enum SysmemAllocation {
    Pending,
    WaitingForSync {
        future: QueryResponseFut<()>,
        token_fn: Option<Box<dyn FnOnce() + Send + Sync>>,
        buffer_collection: BufferCollectionProxy,
    },
    WaitingForAllocation(QueryResponseFut<BufferCollectionWaitForAllBuffersAllocatedResult>, BufferCollectionProxy),
    Done(Result<(), Error>),
}

A Future that communicates with the fuchsia.sysmem2.Allocator service to allocate shared buffers.

Variants

Pending

WaitingForSync

Waiting for the Sync response from the Allocator

Fields

future: QueryResponseFut<()>

token_fn: Option<Box<dyn FnOnce() + Send + Sync>>

buffer_collection: BufferCollectionProxy

WaitingForAllocation(QueryResponseFut<BufferCollectionWaitForAllBuffersAllocatedResult>, BufferCollectionProxy)

Waiting for the buffers to be allocated, which should eventually happen after delivering the token.

Done(Result<(), Error>)

Allocation is completed. The result here represents whether it completed successfully or an error.

Implementations

impl SysmemAllocation

pub fn pending() -> Self

A pending allocation which has not been started, and will never finish.

pub fn allocate<F: FnOnce(ClientEnd<BufferCollectionTokenMarker>) + 'static + Send + Sync>( allocator: AllocatorProxy, name: BufferName<'_>, debug_info: Option<AllocatorDebugInfo>, constraints: BufferCollectionConstraints, token_target_fn: F ) -> Result<Self, Error>

Allocate a new shared memory collection, using allocator to communicate with the Allocator service. constraints will be used to allocate the collection. A shared collection token client end will be provided to the token_target_fn once the request has been synced with the collection. This token can be used with SysmemAllocation::shared to finish allocating the shared buffers or provided to another service to share allocation, or duplicated to share this memory with more than one other client.

pub fn bind( allocator: AllocatorProxy, token: ClientEnd<BufferCollectionTokenMarker>, constraints: BufferCollectionConstraints ) -> Result<Self, Error>

Bind to a shared memory collection, using allocator to communicate with the Allocator service and a token which has already been allocated. constraints is set to communicate the requirements of this client.

Trait Implementations

impl FusedFuture for SysmemAllocation

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl Future for SysmemAllocation

type Output = Result<SysmemAllocatedBuffers, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.