Rename Encoder::encoding to Encoder::options (image-rs#100)

Author: RunDevelopment

benches/encode.rs

@@ -102,7 +102,7 @@ where
 
             let mut encoder =
                 Encoder::new_image(black_box(&mut output), image.size, format, false).unwrap();
-            encoder.encoding = black_box(options).clone();
+            encoder.options = black_box(options).clone();
             let result = encoder.write_surface(black_box(image.view()));
             black_box(result).unwrap();
             black_box(encoder.finish()).unwrap();

src/encode/mod.rs

@@ -227,7 +227,7 @@ fn encode_parallel(
 /// ## See also
 ///
 /// - [`encode`]
-/// - [`Encoder::encoding`](crate::Encoder::encoding)
+/// - [`Encoder::options`](crate::Encoder::options)
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
 #[non_exhaustive]
 pub struct EncodeOptions {

src/encoder.rs

@@ -21,14 +21,14 @@ pub struct Encoder<W> {
 
     /// The encoding options used to encode surfaces.
     ///
-    /// Default: `EncodeOptions::default()`
-    pub encoding: EncodeOptions,
+    /// Default: [`EncodeOptions::default()`]
+    pub options: EncodeOptions,
     /// Options regarding automatic mipmap generation.
     ///
     /// Set `self.mipmaps.generate = false` to disable automatic mipmap
     /// generation.
     ///
-    /// Default: `MipmapOptions::default()`
+    /// Default: [`MipmapOptions::default()`]
     pub mipmaps: MipmapOptions,
 
     // internal cache for resizing
@@ -62,7 +62,7 @@ impl<W> Encoder<W> {
             format,
             layout,
             iter: SurfaceIterator::new(layout),
-            encoding: EncodeOptions::default(),
+            options: EncodeOptions::default(),
             mipmaps: MipmapOptions::default(),
             mipmap_cache: MipmapCache::new(),
         })
@@ -195,7 +195,7 @@ impl<W> Encoder<W> {
             image,
             self.format,
             Some(&mut progress.sub_range(get_level_progress_range(0))),
-            &self.encoding,
+            &self.options,
         )?;
         self.iter.advance();
 
@@ -222,7 +222,7 @@ impl<W> Encoder<W> {
                         mipmap,
                         self.format,
                         Some(&mut progress.sub_range(get_level_progress_range(level))),
-                        &self.encoding,
+                        &self.options,
                     )
                 })?;
         }

src/lib.rs

@@ -83,7 +83,7 @@
 //!     let size = Size::new(width, height);
 //!     let mut encoder = Encoder::new_image(file, size, Format::BC7_UNORM, mipmaps)?;
 //!     // lower quality for faster encoding
-//!     encoder.encoding.quality = CompressionQuality::Fast;
+//!     encoder.options.quality = CompressionQuality::Fast;
 //!
 //!     let view = ImageView::new(image_data, size, ColorFormat::RGBA_U8)
 //!         .expect("invalid image data");
@@ -97,7 +97,7 @@
 //! are generated can be configured using [`Encoder::mipmaps`].
 //!
 //! Most formats also support encoding options to change the encoded image data
-//! in some way. These can be set using the [`Encoder::encoding`] field. E.g.
+//! in some way. These can be set using the [`Encoder::options`] field. E.g.
 //! most formats support [dithering](EncodeOptions::dithering) and compressed
 //! formats support different [quality levels](EncodeOptions::quality) among
 //! others.

tests/encode.rs

@@ -60,7 +60,7 @@ fn encode_decode(
     // encode
     let mut encoded = Vec::new();
     let mut encoder = Encoder::new_image(&mut encoded, image.size, format, false).unwrap();
-    encoder.encoding = options.clone();
+    encoder.options = options.clone();
     encoder.write_surface(image.view()).unwrap();
     encoder.finish().unwrap();
 
@@ -117,8 +117,8 @@ fn encode_base() {
 
         let mut output = Vec::new();
         let mut encoder = Encoder::new_image(&mut output, size, format, false)?;
-        encoder.encoding.quality = CompressionQuality::High;
-        encoder.encoding.parallel = false;
+        encoder.options.quality = CompressionQuality::High;
+        encoder.options.parallel = false;
 
         // and now the image data
         if format.precision() == Precision::U16 {
@@ -161,8 +161,8 @@ fn encode_dither() {
     ) -> Result<String, Box<dyn std::error::Error>> {
         let mut output = Vec::new();
         let mut encoder = Encoder::new_image(&mut output, image.size, format, false)?;
-        encoder.encoding.quality = CompressionQuality::High;
-        encoder.encoding.dithering = Dithering::ColorAndAlpha;
+        encoder.options.quality = CompressionQuality::High;
+        encoder.options.dithering = Dithering::ColorAndAlpha;
         encoder.write_surface(image.view())?;
         encoder.finish()?;
 

tests/progress.rs

@@ -81,7 +81,7 @@ fn track_progress() {
             format,
             mipmaps && format.encoding_support().unwrap().size_multiple().is_none(),
         )?;
-        encoder.encoding = options.clone();
+        encoder.options = options.clone();
 
         encoder.write_surface_with_progress(image, &mut progress)?;
         encoder.finish()?;
@@ -199,7 +199,7 @@ fn forward_progress() {
             format,
             format.encoding_support().unwrap().size_multiple().is_none(),
         )?;
-        encoder.encoding = options.clone();
+        encoder.options = options.clone();
 
         encoder.write_surface_with_progress(image, &mut progress)?;
         encoder.finish()?;