Struct AudioOutputId 

pub struct AudioOutputId(/* private fields */);

Unique identifier of an open audio output.

Name

IDs are only unique for the same process. You can associate a name with an ID to give it a persistent identifier.

Memory

The internal number is a NonZeroU32, that means that Option<AudioOutputId> and AudioOutputId are the same size as u32.

As Hash

The generated internal number has good statistical distribution and can be used as its own hash, although it is not cryptographically safe, as it is simply a sequential counter scrambled using a modified splitmix64.

Static

The unique ID cannot be generated at compile time, but you can use the static_id! macro to declare a lazy static that instantiates the ID.

Exhaustion Handling

If more IDs are generated them u32::MAX an error is logged, the internal counter is reset and ids are reused.

Implementations

impl AudioOutputId

pub fn new_unique() -> Self

Generates a new unique ID.

pub fn get(self) -> u32

Retrieve the underlying value.

pub fn sequential(self) -> u32

Un-scramble the underlying value to get the original sequential count number.

If two IDs, id0 and id1 where generated by the same thread then id0.sequential() < id1.sequential().

pub fn from_raw(raw: u32) -> Self

Creates an ID from a raw value.

The value must not be zero, panics if it is, the value must have been provided by get otherwise the ID will not be unique.

pub fn from_sequential(num: u32) -> Self

Creates an ID from a sequential number.

Safety

The value must not be zero, panics if it is, the value must have been provided by sequential otherwise the ID will not be unique.

impl AudioOutputId

pub fn named(name: impl Into<Txt>) -> Self

Get or generate an ID with associated name.

If the name is already associated with an ID, returns it. If the name is new, generates a new ID and associated it with the name. If name is an empty string just returns a new ID.

pub fn debug_named(name: impl Into<Txt>) -> Self

Calls named in a debug build and new_unique in a release build.

pub fn named_new(name: impl Into<Txt>) -> Result<Self, IdNameError<Self>>

Generate a new ID with associated name.

If the name is already associated with an ID, returns the NameUsed error. If the name is an empty string just returns a new ID.

pub fn name(self) -> Txt

Returns the name associated with the ID or "".

pub fn set_name(self, name: impl Into<Txt>) -> Result<(), IdNameError<Self>>

Associate a name with the ID, if it is not named.

If the name is already associated with a different ID, returns the NameUsed error. If the ID is already named, with a name different from name, returns the AlreadyNamed error. If the name is an empty string or already is the name of the ID, does nothing.

Trait Implementations

impl Clone for AudioOutputId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioOutputId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AudioOutputId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AudioOutputId

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

Formats the value using the given formatter.

impl From<&'static str> for AudioOutputId

fn from(name: &'static str) -> Self

Calls AudioOutputId::named.

impl From<Cow<'static, str>> for AudioOutputId

fn from(name: Cow<'static, str>) -> Self

Calls AudioOutputId::named.

impl From<String> for AudioOutputId

fn from(name: String) -> Self

Calls AudioOutputId::named.

impl From<Txt> for AudioOutputId

fn from(name: Txt) -> Self

Calls AudioOutputId::named.

impl From<char> for AudioOutputId

fn from(name: char) -> Self

Calls AudioOutputId::named.

impl Hash for AudioOutputId

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

where H: Hasher,

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 IntoVar<AudioOutputId> for &'static str

fn into_var(self) -> Var<AudioOutputId>

Calls AudioOutputId::named.

impl IntoVar<AudioOutputId> for Cow<'static, str>

fn into_var(self) -> Var<AudioOutputId>

Calls AudioOutputId::named.

impl IntoVar<AudioOutputId> for String

fn into_var(self) -> Var<AudioOutputId>

Calls AudioOutputId::named.

impl IntoVar<AudioOutputId> for Txt

fn into_var(self) -> Var<AudioOutputId>

Calls AudioOutputId::named.

impl IntoVar<AudioOutputId> for char

fn into_var(self) -> Var<AudioOutputId>

Calls AudioOutputId::named.

impl IntoVar<Option<AudioOutputId>> for AudioOutputId

fn into_var(self) -> Var<Option<AudioOutputId>>

impl PartialEq for AudioOutputId

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 Serialize for AudioOutputId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UniqueId for AudioOutputId

fn new_unique() -> Self

New unique ID.

impl Copy for AudioOutputId

impl Eq for AudioOutputId

impl IntoValue<AudioOutputId> for &'static str

impl IntoValue<AudioOutputId> for Cow<'static, str>

impl IntoValue<AudioOutputId> for String

impl IntoValue<AudioOutputId> for Txt

impl IntoValue<AudioOutputId> for char

impl IntoValue<Option<AudioOutputId>> for AudioOutputId

impl NoUninit for AudioOutputId

impl PodInOption for AudioOutputId

impl ZeroableInOption for AudioOutputId