Struct ResourceRequestHandle 

pub struct ResourceRequestHandle { /* private fields */ }

Owns one native handle.

A resource load that a resource provider answers.

See mln_resource_request in the C API reference.

Implementations

impl ResourceRequestHandle

pub fn id(&self) -> u64

Returns the native handle value.

impl ResourceRequestHandle

pub fn complete(self, response: &ResourceResponse<'_>) -> Result<()>

Answers a resource request.

A failed answer fails the request with ResourceErrorReason::Other, as ResourceRequestHandle::release() does.

See mln_resource_request_complete in the C API reference.

Errors

• Status::InvalidState when the library cancelled the request.

pub fn is_cancelled(&self) -> Result<bool>

Reads whether the library cancelled a resource request.

See mln_resource_request_is_cancelled in the C API reference.

pub fn pass_through(self) -> Result<()>

Hands a resource request back to the library to load as usual.

A failed call fails the request with ResourceErrorReason::Other, as ResourceRequestHandle::release() does.

See mln_resource_request_pass_through in the C API reference.

Errors

• Status::InvalidState when the library cancelled the request.

pub fn release(self) -> Result<(), ReleaseError<Self>>

Releases a resource request.

Releasing a request without an answer fails it with ResourceErrorReason::Other.

See mln_resource_request_release in the C API reference.

pub fn set_cancel_callback( &self, handler: ResourceRequestCancelHandler, ) -> Result<bool>

Calls a callback when the library cancels a resource request.

The callback never runs after the request is answered. A request takes one cancel callback. When the library has already cancelled the request, the call reports that instead and the callback never runs.

See mln_resource_request_set_cancel_callback in the C API reference.

Trait Implementations

impl Debug for ResourceRequestHandle

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

Formats the value using the given formatter.