Enum HostId 

pub enum HostId {
    Alsa,
}

Unique identifier for available hosts on the platform.

Only the hosts supported by the current platform are available as enum variants. For cross-platform code that needs to handle hosts from other platforms, use the string representation via std::fmt::Display/std::str::FromStr.

Available Host Strings

For cross-platform matching, these host strings are available:

• "aaudio" - Android Audio
• "alsa" - Advanced Linux Sound Architecture
• "asio" - ASIO
• "coreaudio" - CoreAudio
• "custom" - Custom host (requires custom feature)
• "emscripten" - Emscripten
• "jack" - JACK Audio Connection Kit
• "null" - Null host
• "wasapi" - Windows Audio Session API
• "webaudio" - Web Audio API
• "audioworklet" - Audio Worklet

Cross-Platform Example

use cpal::HostId;
use std::str::FromStr;

fn handle_host_string(host_string: &str) {
    // String matching works on all platforms
    match host_string {
        "alsa" => println!("ALSA host"),
        "coreaudio" => println!("CoreAudio host"),
        "jack" => println!("JACK host"),
        "wasapi" => println!("WASAPI host"),
        "asio" => println!("ASIO host"),
        "aaudio" => println!("AAudio host"),
        _ => println!("Other host"),
    }

    // Parse host string (may fail if host is not available on this platform)
    if let Ok(host_id) = HostId::from_str(host_string) {
        println!("Successfully parsed: {}", host_id);
    }
}

Variants

Alsa

Implementations

impl HostId

pub fn name(&self) -> &'static str

Trait Implementations

impl Clone for HostId

fn clone(&self) -> HostId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostId

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

Formats the value using the given formatter.

impl Display for HostId

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

Formats the value using the given formatter.

impl FromStr for HostId

type Err = HostUnavailable

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for HostId

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

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 PartialEq for HostId

fn eq(&self, other: &HostId) -> 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 Copy for HostId

impl Eq for HostId

impl StructuralPartialEq for HostId