Merge pull request #308 from cormac-obrien/expose-playerror

Document PlayError and expose in public API
RustAudio · Aug 5, 2020 · b376b91 · b376b91
2 parents 82b4952 + fb176a6
commit b376b91
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/lib.rs b/src/lib.rs
@@ -104,4 +104,4 @@ pub use crate::decoder::Decoder;
 pub use crate::sink::Sink;
 pub use crate::source::Source;
 pub use crate::spatial_sink::SpatialSink;
-pub use crate::stream::{OutputStream, OutputStreamHandle, StreamError};
+pub use crate::stream::{OutputStream, OutputStreamHandle, PlayError, StreamError};
diff --git a/src/stream.rs b/src/stream.rs
@@ -70,9 +70,12 @@ impl OutputStreamHandle {
     }
 }
 
+/// An error occurred while attemping to play a sound.
 #[derive(Debug)]
 pub enum PlayError {
+    /// Attempting to decode the audio failed.
     DecoderError(decoder::DecoderError),
+    /// The output device was lost.
     NoDevice,
 }