Struct dome_cloomnik::Channel

#[repr(transparent)]pub struct Channel<T: Send + Sync = ()>(_, _);

A DOME audio channel.

A channel provides various methods to handle it. Note that the main work in channels happen in their callbacks, and not in other code, but it's nice anyway. The main thing that you can do with a channel is to stop it (using the Channel::stop() method) but this can only be done when the channel is not shared.

Channels are thread-safe.

When a channel drops, it is automagically stopped. If this is not desired, use mem::forget() to not drop it.

Implementations

impl<T: Send + Sync> Channel<T>

pub fn state(&self) -> ChannelState

Queries the state of this channel.

pub fn set_state(&mut self, state: ChannelState)

Sets the state for this channel.

pub fn stop(self)

Stops the channel. This is not a magic: it just takes ownership of the channel (see Channel).

pub fn data(&self) -> Option<RwLockReadGuard<'_, T>>

Gets the user data associated with this channel, for read only. Channels are using RwLock to hold user data, so you can have multiple read-only references but only one read-write reference at a time.

pub fn data_mut(&self) -> Option<RwLockWriteGuard<'_, T>>

Gets the user data associated with this channel, for read and write. Channels are using RwLock to hold user data, so you can have multiple read-only references but only one read-write reference at a time.

Trait Implementations

impl<T: Debug + Send + Sync> Debug for Channel<T>

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

Formats the value using the given formatter.

impl<T: Send + Sync> Drop for Channel<T>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Channel

impl Sync for Channel