add section on features, decribe tracing feature

This commit is contained in:
github-actions[bot] 2024-09-28 13:59:15 +02:00
parent 95a466e03a
commit a4e12d09b3
No known key found for this signature in database
GPG key ID: F687E89FC7894F98

View file

@ -101,6 +101,15 @@
//! to avoid adding extra crates to your binary.
//! See the [available feature flags](https://docs.rs/crate/rodio/latest/features) for all options.
//!
//! ## Optional Features
//!
//! Rodio provides several optional features that are guarded with feature gates.
//!
//! ### Feature "tracing"
//!
//! The "tracing" feature replaces the print to stderr when a stream error happens with a
//! recording an error event with tracing.
//!
//! ## How it works under the hood
//!
//! Rodio spawns a background thread that is dedicated to reading from the sources and sending