Merge branch 'master' into mp/engine

Author: marshallpierce

.circleci/config.yml

@@ -0,0 +1,80 @@
+version: '2.1'
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build:
+          matrix:
+            parameters:
+              rust_img: [
+                  # The default rust images (not -slim or -alpine) are based on buildpack-deps. Hopefully this will
+                  # be easier on the CI hosts since presumably those fat lower layers will already be cached, and
+                  # therefore faster than a minimal, customized alpine.
+                  # MSRV
+                  'rust:1.47.0',
+                  # stable
+                  'rust:latest',
+                  'rustlang/rust:nightly'
+                  # would be nice to have beta as well: https://github.com/rust-lang/docker-rust/issues/14
+              ]
+
+jobs:
+  build:
+    parameters:
+      rust_img:
+        type: string
+    docker:
+      - image: << parameters.rust_img >>
+    steps:
+      - checkout
+      - restore_cache:
+          key: project-cache-v3-<< parameters.rust_img >>-{{ checksum "Cargo.toml" }}
+      - run:
+          name: Check formatting
+          command: |
+            rustup component add rustfmt
+            cargo fmt -- --check
+      - run:
+          name: Add arm toolchain
+          command: rustup target add thumbv6m-none-eabi
+      - run:
+          name: Build all targets
+          command: cargo build --all-targets
+      - run:
+          name: Build without default features
+          command: cargo build --no-default-features
+      - run:
+          name: Build with only alloc
+          command: cargo build --no-default-features --features alloc
+      - run:
+          name: Build ARM without default features (no_std)
+          command: cargo build --target thumbv6m-none-eabi --no-default-features
+      - run:
+          name: Build ARM with only alloc feature
+          command: cargo build --target thumbv6m-none-eabi --no-default-features --features alloc
+      - run:
+          name: Run tests
+          command: cargo test --verbose
+      - run:
+          name: Build docs
+          command: cargo doc --verbose
+      - run:
+          name: Confirm a fuzzer can run
+          # TERM=dumb prevents cargo fuzz list from printing with color
+          environment:
+            TERM: dumb
+          command: |
+            if [[ '<< parameters.rust_img >>' = 'rustlang/rust:nightly' ]]
+            then
+              cargo +nightly install cargo-fuzz
+              cargo fuzz list | xargs -L 1 -I FUZZER cargo fuzz run FUZZER -- -max_total_time=1
+            fi
+
+      - save_cache:
+          key: project-cache-v3-<< parameters.rust_img >>-{{ checksum "Cargo.toml" }}
+          paths:
+            # rust docker img doesn't use $HOME/[.cargo,.rustup]
+            - /usr/local/cargo
+            - /usr/local/rustup
+            - ./target

.travis.yml

@@ -6,8 +6,8 @@
   - Standard base64 per the RFC is available via `DEFAULT_ENGINE`. To use different alphabets or other settings (padding, etc), create your own engine instance.
 - `CharacterSet` is now `Alphabet` (per the RFC), and allows creating custom alphabets. The corresponding tables that were previously code-generated are now built dynamically.
 - Since there are already multiple breaking changes, various functions are renamed to be more consistent and discoverable
-- DecoderReader now owns its delegate reader
 - MSRV is now 1.47.0
+- DecoderReader now owns its inner reader, and can expose it via `into_inner()`. For symmetry, `EncoderWriter` can do the same with its writer.
 
 # 0.13.0
 

RELEASE-NOTES.md

@@ -55,6 +55,13 @@ const MIN_ENCODE_CHUNK_SIZE: usize = 3;
 ///
 /// It has some minor performance loss compared to encoding slices (a couple percent).
 /// It does not do any heap allocation.
+///
+/// # Limitations
+///
+/// Owing to the specification of the `write` and `flush` methods on the `Write` trait and their
+/// implications for a buffering implementation, these methods may not behave as expected. In
+/// particular, calling `write_all` on this interface may fail with `io::ErrorKind::WriteZero`.
+/// See the documentation of the `Write` trait implementation for further details.
 pub struct EncoderWriter<'e, E: Engine, W: io::Write> {
     engine: &'e E,
     /// Where encoded data is written to. It's an Option as it's None immediately before Drop is