Rename settings to write_settings

Author: LaurenzV

src/chunk.rs

@@ -1,13 +1,18 @@
 use super::*;
 
+/// Settings that should be applied while writing a PDF file.
 #[derive(Debug, Clone, Copy)]
 pub struct WriteSettings {
+    /// Whether to enable pretty-writing. In this case, `pdf-writer` will serialize PDFs in such
+    /// a way that they are easier to read by humans by applying more padding and indentation, at
+    /// the cost of higher file sizes. If disabled, `pdf-writer` will serialize objects as compactly
+    /// as possible, leading to better file sizes but making it harder to inspect the file manually.
     pub pretty: bool,
 }
 
 impl Default for WriteSettings {
     fn default() -> Self {
-        Self { pretty: false }
+        Self { pretty: true }
     }
 }
 
@@ -25,7 +30,7 @@ impl Default for WriteSettings {
 pub struct Chunk {
     pub(crate) buf: Buf,
     pub(crate) offsets: Vec<(Ref, usize)>,
-    pub(crate) settings: WriteSettings,
+    pub(crate) write_settings: WriteSettings,
 }
 
 impl Chunk {
@@ -40,14 +45,14 @@ impl Chunk {
         Self {
             buf: Buf::with_capacity(capacity),
             offsets: vec![],
-            settings: Default::default(),
+            write_settings: Default::default(),
         }
     }
 
     /// TODO
-    pub fn new_with(settings: WriteSettings) -> Self {
+    pub fn new_with(write_settings: WriteSettings) -> Self {
         let mut chunk = Self::new();
-        chunk.settings = settings;
+        chunk.write_settings = write_settings;
 
         chunk
     }
@@ -172,7 +177,7 @@ impl Chunk {
     /// Start writing an indirectly referenceable object.
     pub fn indirect(&mut self, id: Ref) -> Obj<'_> {
         self.offsets.push((id, self.buf.len()));
-        Obj::indirect(&mut self.buf, id, self.settings)
+        Obj::indirect(&mut self.buf, id, self.write_settings)
     }
 
     /// Start writing an indirectly referenceable stream.

src/content.rs

@@ -5,7 +5,7 @@ use crate::object::TextStrLike;
 /// A builder for a content stream.
 pub struct Content {
     buf: Buf,
-    settings: WriteSettings,
+    write_settings: WriteSettings,
     q_depth: usize,
 }
 
@@ -19,9 +19,9 @@ impl Content {
     }
 
     /// TODO
-    pub fn new_with(settings: WriteSettings) -> Self {
+    pub fn new_with(write_settings: WriteSettings) -> Self {
         let mut content = Self::new();
-        content.settings = settings;
+        content.write_settings = write_settings;
 
         content
     }
@@ -31,14 +31,14 @@ impl Content {
         Self {
             buf: Buf::with_capacity(capacity),
             q_depth: 0,
-            settings: Default::default(),
+            write_settings: Default::default(),
         }
     }
 
     /// Start writing an arbitrary operation.
     #[inline]
     pub fn op<'a>(&'a mut self, operator: &'a str) -> Operation<'a> {
-        Operation::start(&mut self.buf, operator, self.settings)
+        Operation::start(&mut self.buf, operator, self.write_settings)
     }
 
     /// Return the buffer of the content stream.
@@ -65,13 +65,17 @@ pub struct Operation<'a> {
     buf: &'a mut Buf,
     op: &'a str,
     first: bool,
-    settings: WriteSettings,
+    write_settings: WriteSettings,
 }
 
 impl<'a> Operation<'a> {
     #[inline]
-    pub(crate) fn start(buf: &'a mut Buf, op: &'a str, settings: WriteSettings) -> Self {
-        Self { buf, op, first: true, settings }
+    pub(crate) fn start(
+        buf: &'a mut Buf,
+        op: &'a str,
+        write_settings: WriteSettings,
+    ) -> Self {
+        Self { buf, op, first: true, write_settings }
     }
 
     /// Write a primitive operand.
@@ -102,7 +106,7 @@ impl<'a> Operation<'a> {
         }
         self.first = false;
         // TODO: Refine padding?
-        Obj::direct(self.buf, 0, self.settings, false)
+        Obj::direct(self.buf, 0, self.write_settings, false)
     }
 }
 

src/lib.rs

@@ -298,7 +298,7 @@ impl Pdf {
     ///
     /// Panics if any indirect reference id was used twice.
     pub fn finish(self) -> Vec<u8> {
-        let Chunk { mut buf, mut offsets, settings } = self.chunk;
+        let Chunk { mut buf, mut offsets, write_settings } = self.chunk;
 
         offsets.sort();
 
@@ -346,7 +346,7 @@ impl Pdf {
         // Write the trailer dictionary.
         buf.extend(b"trailer\n");
 
-        let mut trailer = Obj::direct(&mut buf, 0, settings, false).dict();
+        let mut trailer = Obj::direct(&mut buf, 0, write_settings, false).dict();
         trailer.pair(Name(b"Size"), xref_len);
 
         if let Some(catalog_id) = self.catalog_id {

src/object.rs

@@ -603,7 +603,7 @@ pub struct Obj<'a> {
     buf: &'a mut Buf,
     indirect: bool,
     indent: u8,
-    settings: WriteSettings,
+    write_settings: WriteSettings,
     needs_padding: bool,
 }
 
@@ -613,28 +613,32 @@ impl<'a> Obj<'a> {
     pub(crate) fn direct(
         buf: &'a mut Buf,
         indent: u8,
-        settings: WriteSettings,
+        write_settings: WriteSettings,
         needs_padding: bool,
     ) -> Self {
         Self {
             buf,
             indirect: false,
             indent,
-            settings,
+            write_settings,
             needs_padding,
         }
     }
 
     /// Start a new indirect object.
     #[inline]
-    pub(crate) fn indirect(buf: &'a mut Buf, id: Ref, settings: WriteSettings) -> Self {
+    pub(crate) fn indirect(
+        buf: &'a mut Buf,
+        id: Ref,
+        write_settings: WriteSettings,
+    ) -> Self {
         buf.push_int(id.get());
         buf.extend(b" 0 obj\n");
         Self {
             buf,
             indirect: true,
             indent: 0,
-            settings,
+            write_settings,
             needs_padding: false,
         }
     }
@@ -650,7 +654,7 @@ impl<'a> Obj<'a> {
         if self.indirect {
             self.buf.extend(b"\nendobj\n");
 
-            if self.settings.pretty {
+            if self.write_settings.pretty {
                 self.buf.extend(b"\n");
             }
         }
@@ -720,7 +724,7 @@ writer!(Array: |obj| {
         buf: obj.buf,
         indirect: obj.indirect,
         indent: obj.indent,
-        settings: obj.settings,
+        settings: obj.write_settings,
         len: 0,
     }
 });
@@ -880,7 +884,7 @@ writer!(Dict: |obj| {
         buf: obj.buf,
         indirect: obj.indirect,
         indent: obj.indent.saturating_add(2),
-        settings: obj.settings,
+        settings: obj.write_settings,
         len: 0,
     }
 });

src/renumber.rs

@@ -20,7 +20,7 @@ pub fn renumber(source: &Chunk, target: &mut Chunk, mapping: &mut dyn FnMut(Ref)
         patch_object(slice, &mut target.buf, mapping);
         target.buf.extend(b"\nendobj\n");
 
-        if target.settings.pretty {
+        if target.write_settings.pretty {
             target.buf.extend(b"\n");
         }
     }