chore: Fix clippy errors on beta

This commit is contained in:
Kamil Jarosz 2024-09-04 17:18:37 +02:00
parent f538f67a17
commit 8dac02bf95
7 changed files with 24 additions and 10 deletions

View File

@ -7,7 +7,8 @@ use syn::{
TraitItem, Visibility, TraitItem, Visibility,
}; };
/// `enum_trait_object` will define an enum whose variants each implement a trait. /// Define an enum whose variants each implement a trait.
///
/// It can be used as faux-dynamic dispatch. This is used as an alternative to a /// It can be used as faux-dynamic dispatch. This is used as an alternative to a
/// trait object, which doesn't get along with GC'd types. /// trait object, which doesn't get along with GC'd types.
/// ///

View File

@ -97,6 +97,8 @@ impl<T: Decoder + ?Sized> Decoder for Box<T> {
} }
} }
/// Audio stream decoder.
///
/// A "stream" sound is a sound that has its data distributed across `SoundStreamBlock` tags, /// A "stream" sound is a sound that has its data distributed across `SoundStreamBlock` tags,
/// one per each frame of a MovieClip. The sound is synced to the MovieClip's timeline, and will /// one per each frame of a MovieClip. The sound is synced to the MovieClip's timeline, and will
/// stop/seek as the MovieClip stops/seeks. /// stop/seek as the MovieClip stops/seeks.
@ -144,6 +146,8 @@ impl Iterator for StandardStreamDecoder {
} }
} }
/// ADPCM stream decoder.
///
/// Stream sounds encoded with ADPCM have an ADPCM header in each `SoundStreamBlock` tag, unlike /// Stream sounds encoded with ADPCM have an ADPCM header in each `SoundStreamBlock` tag, unlike
/// other compression formats that remain the same as if they were a single sound clip. /// other compression formats that remain the same as if they were a single sound clip.
/// Therefore, we must recreate the decoder with each `SoundStreamBlock` to parse the additional /// Therefore, we must recreate the decoder with each `SoundStreamBlock` to parse the additional
@ -482,6 +486,7 @@ impl Read for SubstreamTagReader {
} }
/// Create a new decoder that reads data from a shared `Substream` instance. /// Create a new decoder that reads data from a shared `Substream` instance.
///
/// This works similarly to `make_stream_decoder` but using the new buffer /// This works similarly to `make_stream_decoder` but using the new buffer
/// infrastructure that will eventually replace SWF-specific streaming. /// infrastructure that will eventually replace SWF-specific streaming.
/// ///
@ -537,6 +542,8 @@ impl Iterator for StandardSubstreamDecoder {
} }
} }
/// ADPCM substream decoder.
///
/// Stream sounds encoded with ADPCM have an ADPCM header in each `SoundStreamBlock` tag, unlike /// Stream sounds encoded with ADPCM have an ADPCM header in each `SoundStreamBlock` tag, unlike
/// other compression formats that remain the same as if they were a single sound clip. /// other compression formats that remain the same as if they were a single sound clip.
/// Therefore, we must recreate the decoder with each `SoundStreamBlock` to parse the additional /// Therefore, we must recreate the decoder with each `SoundStreamBlock` to parse the additional

View File

@ -617,11 +617,13 @@ impl From<MouseButton> for KeyCode {
} }
} }
/// Key codes for SWF4 keyPress button handlers. These are annoyingly different than /// Key codes for SWF4 keyPress button handlers.
/// `Key.isDown` key codes. ///
/// These are annoyingly different than `Key.isDown` key codes.
///
/// TODO: After 18, these are mostly ASCII... should we just use u8? How are different /// TODO: After 18, these are mostly ASCII... should we just use u8? How are different
/// keyboard layouts/languages handled? /// keyboard layouts/languages handled?
/// SWF19 pp. 198-199 /// SWF19 pp. 198-199
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive, ToPrimitive)] #[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive, ToPrimitive)]
pub enum ButtonKeyCode { pub enum ButtonKeyCode {
Unknown = 0, Unknown = 0,

View File

@ -15,6 +15,7 @@ use gc_arena::Collect;
use std::collections::BTreeMap; use std::collections::BTreeMap;
/// An intermediate format of representing shared data between ActionScript and elsewhere. /// An intermediate format of representing shared data between ActionScript and elsewhere.
///
/// Regardless of the capabilities of both sides, all data will be translated to this potentially /// Regardless of the capabilities of both sides, all data will be translated to this potentially
/// lossy format. Any recursion or additional metadata in ActionScript will not be translated. /// lossy format. Any recursion or additional metadata in ActionScript will not be translated.
#[derive(Debug, Clone, PartialEq)] #[derive(Debug, Clone, PartialEq)]

View File

@ -27,6 +27,7 @@ pub trait CommandHandler {
} }
/// Holds either a normal BlendMode, or the shader for BlendMode.SHADER. /// Holds either a normal BlendMode, or the shader for BlendMode.SHADER.
///
/// We cannot store the `PixelBenderShaderHandle` directly in `ExtendedBlendMode`, /// We cannot store the `PixelBenderShaderHandle` directly in `ExtendedBlendMode`,
/// since we need to remember the shader even if the blend mode is changed /// since we need to remember the shader even if the blend mode is changed
/// to something else (so that the shader will still be used if we switch back) /// to something else (so that the shader will still be used if we switch back)

View File

@ -272,10 +272,11 @@ pub enum PixelBenderShaderArgument<'a> {
}, },
} }
/// An image input. This accepts both an owned BitmapHandle, /// An image input.
/// and a borrowed texture (used when applying a filter to ///
/// a texture that we don't have ownership of, and therefore /// This accepts both an owned BitmapHandle, and a borrowed texture
/// cannot construct a BitmapHandle for). /// (used when applying a filter to a texture that we don't have
/// ownership of, and therefore cannot construct a BitmapHandle for).
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub enum ImageInputTexture<'a> { pub enum ImageInputTexture<'a> {
Bitmap(BitmapHandle), Bitmap(BitmapHandle),

View File

@ -1785,7 +1785,8 @@ pub type DoAction<'a> = &'a [u8];
pub type JpegTables<'a> = &'a [u8]; pub type JpegTables<'a> = &'a [u8];
/// `ProductInfo` contains information about the software used to generate the SWF. /// Contains information about the software used to generate the SWF.
///
/// Not documented in the SWF19 reference. Emitted by mxmlc. /// Not documented in the SWF19 reference. Emitted by mxmlc.
/// See <http://wahlers.com.br/claus/blog/undocumented-swf-tags-written-by-mxmlc/> /// See <http://wahlers.com.br/claus/blog/undocumented-swf-tags-written-by-mxmlc/>
#[derive(Clone, Debug, Eq, PartialEq)] #[derive(Clone, Debug, Eq, PartialEq)]