Struct CMSimpleQueue 

pub struct CMSimpleQueue { /* private fields */ }

Available on crate feature CMSimpleQueue only.

A reference to a CMSimpleQueue, a CF object that implements a simple lockless queue of (void *) elements.

See also Apple’s documentation

Implementations

impl CMSimpleQueue

pub unsafe fn create( allocator: Option<&CFAllocator>, capacity: i32, queue_out: NonNull<*mut CMSimpleQueue>, ) -> i32

Creates a CMSimpleQueue.

On return, the caller owns the returned CMSimpleQueue, and must release it when done with it.

Returns: Returns noErr if the call succeeds. Returns kCMSimpleQueueError_ParameterOutOfRange if capacity is negative.

Safety

queue_out must be a valid pointer.

pub unsafe fn enqueue(&self, element: NonNull<c_void>) -> i32

Enqueues an element on the queue.

If the queue is full, this operation will fail.

Returns: Returns noErr if the call succeeds, kCMSimpleQueueError_QueueIsFull if the queue is full.

Safety

element must be a valid pointer.

pub unsafe fn dequeue(&self) -> *const c_void

Dequeues an element from the queue.

If the queue is empty, NULL will be returned.

Returns: The dequeued element. NULL if the queue was empty, or if there was some other error.

pub unsafe fn head(&self) -> *const c_void

Returns the element at the head of the queue.

If the queue is empty, NULL will be returned.

Returns: The head element. NULL if the queue was empty, or if there was some other error.

pub unsafe fn reset(&self) -> i32

Resets the queue.

This function resets the queue to its empty state; all values in the queue prior to reset are lost. Note that CMSimpleQueueReset is not synchronized in any way, so the reader thread and writer thread must be held off by the client during this operation.

Returns: Returns noErr if the call succeeds.

pub unsafe fn capacity(&self) -> i32

Returns the number of elements that can be held in the queue.

Returns: The number of elements that can be held in the queue. Returns 0 if there is an error.

pub unsafe fn count(&self) -> i32

Returns the number of elements currently on the queue.

Returns: The number of elements currently in the queue. Returns 0 if there is an error.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Available on crate feature CMAttachment only.

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Available on crate feature CMAttachment only.

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CMSimpleQueue

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CMSimpleQueue

fn as_ref(&self) -> &CFType

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

impl AsRef<CMSimpleQueue> for CMSimpleQueue

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CMSimpleQueue

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CMSimpleQueue

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CMSimpleQueue

fn type_id() -> CFTypeID

Returns the CFTypeID of CMSimpleQueue objects.

You can check if a CFTypeRef object is actually a CMSimpleQueue by comparing CFGetTypeID(object) with CMSimpleQueueGetTypeID().

Returns: CFTypeID of CMSimpleQueue objects.

impl Debug for CMSimpleQueue

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

Formats the value using the given formatter.

impl Deref for CMSimpleQueue

type Target = CFType

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for CMSimpleQueue

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for CMSimpleQueue

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CMSimpleQueue

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for CMSimpleQueue

const ENCODING_REF: Encoding

The Objective-C type-encoding for a reference of this type.

impl Type for CMSimpleQueue

fn retain(&self) -> CFRetained<Self>

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CMSimpleQueue