Struct RegistryRc

pub struct RegistryRc { /* private fields */ }

Reference counting smart pointer providing shared ownership of a PipeWire registry.

For the non-owning variant, see RegistryWeak. For unique ownership, see RegistryBox.

For an explanation of these, see Smart pointers to PipeWire objects.

Implementations

impl RegistryRc

pub unsafe fn from_raw(ptr: NonNull<pw_registry>, core: CoreRc) -> Self

Create a RegistryRc by taking ownership of a raw pw_registry.

Safety

The provided pointer must point to a valid, well aligned pw_registry.

The raw registry must not be manually destroyed or moved, as the new RegistryRc takes ownership of it.

pub fn downgrade(&self) -> RegistryWeak

Methods from Deref<Target = Registry>

pub fn as_raw(&self) -> &pw_registry

pub fn as_raw_ptr(&self) -> *mut pw_registry

pub fn add_listener_local(&self) -> ListenerLocalBuilder<'_>

pub fn bind<T: ProxyT, P: AsRef<DictRef>>( &self, object: &GlobalObject<P>, ) -> Result<T, Error>

Bind to a global object.

Bind to the global object and get a proxy to the object. After this call, methods can be sent to the remote global object and events can be received.

Usually this is called in callbacks for the global event.

Errors

If T does not match the type of the global object, Error::WrongProxyType is returned.

pub fn destroy_global(&self, global_id: u32) -> SpaResult

Attempt to destroy the global object with the specified id on the remote.

Permissions

Requires X permissions on the global.

Trait Implementations

impl AsRef<Registry> for RegistryRc

fn as_ref(&self) -> &Registry

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

impl Clone for RegistryRc

fn clone(&self) -> RegistryRc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegistryRc

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

Formats the value using the given formatter.

impl Deref for RegistryRc

type Target = Registry

The resulting type after dereferencing.

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

Dereferences the value.