Struct RegistryBox

pub struct RegistryBox<'c> { /* private fields */ }

Smart pointer providing unique ownership of a PipeWire registry.

For shared ownership, see RegistryRc.

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

Implementations

impl<'c> RegistryBox<'c>

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

Create a RegistryBox 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 RegistryBox takes ownership of it.

The lifetime of the returned box is unbounded. The caller is responsible to make sure that the core used with this registry outlives the registry.

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<'c> AsRef<Registry> for RegistryBox<'c>

fn as_ref(&self) -> &Registry

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

impl<'c> Debug for RegistryBox<'c>

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

Formats the value using the given formatter.

impl<'c> Deref for RegistryBox<'c>

type Target = Registry

The resulting type after dereferencing.

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

Dereferences the value.

impl<'c> Drop for RegistryBox<'c>

fn drop(&mut self)

Executes the destructor for this type.