Struct harfbuzz_rs::Shared

pub struct Shared<T: HarfbuzzObject> { /* fields omitted */ }

A smart pointer that wraps an atomically reference counted HarfBuzz object.

Usually you don't create a Shared yourself, but get it from another function in this crate. You can just use the methods of the wrapped object through its Deref implementation.

A Shared is a safe wrapper for reference counted HarfBuzz objects and provides shared immutable access to its inner object. As HarfBuzz' objects are all thread-safe Shared implements Send and Sync.

Tries to mirror the stdlib Arc interface where applicable as HarfBuzz' reference counting has similar semantics.

Methods

impl<T: HarfbuzzObject> Shared<T>

pub unsafe fn from_raw_owned(raw: *mut T::Raw) -> Self

Creates a Shared from an owned raw harfbuzz pointer.

Transfers ownership. Use of the original pointer is now forbidden! Unsafe because dereferencing a raw pointer is necessary.

pub fn into_raw(shared: Shared<T>) -> *mut T::Raw

Converts self into the underlying harfbuzz object pointer value. The resulting pointer has to be manually destroyed using hb_TYPE_destroy or be converted back into the wrapper using the from_raw function to avoid leaking memory.

pub unsafe fn from_raw_ref(raw: *mut T::Raw) -> Self

Creates a Shared by cloning a raw harfbuzz pointer.

The original pointer can still be safely used but must be released at the end to avoid memory leaks.

Trait Implementations

impl<T: Eq + HarfbuzzObject> Eq for Shared<T>

impl<T: HarfbuzzObject> Clone for Shared<T>

fn clone(&self) -> Self

Returns a copy and increases the reference count.

This behaviour is exactly like Arc::clone in the standard library.

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

Performs copy-assignment from source.

impl<T: HarfbuzzObject + Sync + Send> Send for Shared<T>

impl<T: HarfbuzzObject> Drop for Shared<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: PartialEq + HarfbuzzObject> PartialEq<Shared<T>> for Shared<T>

fn eq(&self, other: &Shared<T>) -> bool

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

fn ne(&self, other: &Shared<T>) -> bool

This method tests for !=.

impl<T: HarfbuzzObject + Sync + Send> Sync for Shared<T>

impl<'a> Default for Shared<Font<'a>>

fn default() -> Self

Returns the "default value" for a type.

impl<'a, T> From<T> for Shared<Blob<'a>> where
    T: 'a + Send + AsRef<[u8]>, 

fn from(container: T) -> Shared<Blob<'a>>

Performs the conversion.

impl<T: HarfbuzzObject> From<Owned<T>> for Shared<T>

fn from(t: Owned<T>) -> Self

Performs the conversion.

impl<T: HarfbuzzObject> Deref for Shared<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Debug + HarfbuzzObject> Debug for Shared<T>

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

Formats the value using the given formatter.

impl<T: HarfbuzzObject> Borrow<T> for Shared<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.