wasmtime 20.0.2 → 21.0.1

data/ext/cargo-vendor/cobs-0.2.3/Cargo.toml

@@ -0,0 +1,39 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "cobs"
+version = "0.2.3"
+authors = [
+    "Allen Welkie <>",
+    "James Munns <james.munns@ferrous-systems.com>",
+]
+description = """
+    This is an implementation of the Consistent Overhead Byte Stuffing (COBS) algorithm.
+    COBS is an algorithm for transforming a message into an encoding where a specific value
+    (the \"sentinel\" value) is not used. This value can then be used to mark frame boundaries
+    in a serial communication channel. """
+keywords = [
+    "consistent",
+    "overhead",
+    "byte",
+    "stuffing",
+]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/jamesmunns/cobs.rs"
+
+[dev-dependencies.quickcheck]
+version = "^0.5.0"
+
+[features]
+default = ["use_std"]
+use_std = []

data/ext/cargo-vendor/cobs-0.2.3/LICENSE-APACHE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/ext/cargo-vendor/cobs-0.2.3/LICENSE-MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2015 The cobs.rs Developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/ext/cargo-vendor/cobs-0.2.3/README.md

@@ -0,0 +1,23 @@
+# `cobs`
+
+This is an implementation of the Consistent Overhead Byte Stuffing (COBS) algorithm in Rust.
+
+COBS is an algorithm for transforming a message into an encoding where a specific value (the "sentinel" value) is not used. This value can then be used to mark frame boundaries in a serial communication channel.
+
+See www.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing for details.
+
+## License
+
+Licensed under either of
+
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in the work by you, as defined in the Apache-2.0
+license, shall be dual licensed as above, without any additional terms or
+conditions.

data/ext/cargo-vendor/cobs-0.2.3/src/dec.rs

@@ -0,0 +1,360 @@
+/// The [`CobsDecoder`] type is used to decode a stream of bytes to a
+/// given mutable output slice. This is often useful when heap data
+/// structures are not available, or when not all message bytes are
+/// received at a single point in time.
+#[derive(Debug)]
+pub struct CobsDecoder<'a> {
+    /// Destination slice for decoded message
+    dest: &'a mut [u8],
+
+    /// Index of next byte to write in `dest`
+    dest_idx: usize,
+
+    /// Decoder state as an enum
+    state: DecoderState,
+}
+
+/// The [`DecoderState`] is used to track the current state of a
+/// streaming decoder. This struct does not contain the output buffer
+/// (or a reference to one), and can be used when streaming the decoded
+/// output to a custom data type.
+#[derive(Debug)]
+pub enum DecoderState {
+    /// State machine has not received any non-zero bytes
+    Idle,
+
+    /// 1-254 bytes, can be header or 00
+    Grab(u8),
+
+    /// 255 bytes, will be a header next
+    GrabChain(u8),
+}
+
+fn add(to: &mut [u8], idx: usize, data: u8) -> Result<(), ()> {
+    *to.get_mut(idx)
+        .ok_or_else(|| ())? = data;
+    Ok(())
+}
+
+/// [`DecodeResult`] represents the possible non-error outcomes of
+/// pushing an encoded data byte into the [`DecoderState`] state machine
+pub enum DecodeResult {
+    /// The given input byte did not prompt an output byte, either because the
+    /// state machine is still idle, or we have just processed a header byte.
+    /// More data is needed to complete the message.
+    NoData,
+
+    /// We have received a complete and well-encoded COBS message. The
+    /// contents of the associated output buffer may now be used
+    DataComplete,
+
+    /// The following byte should be appended to the current end of the decoded
+    /// output buffer.
+    /// More data is needed to complete the message.
+    DataContinue(u8),
+}
+
+impl DecoderState {
+    /// Push a single encoded byte into the state machine. If the input was
+    /// unexpected, such as an early end of a framed message segment, an Error will
+    /// be returned, and the current associated output buffer contents should be discarded.
+    ///
+    /// If a complete message is indicated, the decoding state machine will automatically
+    /// reset itself to the Idle state, and may be used to begin decoding another message.
+    ///
+    /// NOTE: Sentinel value must be included in the input to this function for the
+    /// decoding to complete
+    pub fn feed(&mut self, data: u8) -> Result<DecodeResult, ()> {
+        use DecoderState::*;
+        use DecodeResult::*;
+        let (ret, state) = match (&self, data) {
+            // Currently Idle, received a terminator, ignore, stay idle
+            (Idle, 0x00) => (Ok(NoData), Idle),
+
+            // Currently Idle, received a byte indicating the
+            // next 255 bytes have no zeroes, so we will have 254 unmodified
+            // data bytes, then an overhead byte
+            (Idle, 0xFF) => (Ok(NoData), GrabChain(0xFE)),
+
+            // Currently Idle, received a byte indicating there will be a
+            // zero that must be modified in the next 1..=254 bytes
+            (Idle, n)    => (Ok(NoData), Grab(n - 1)),
+
+            // We have reached the end of a data run indicated by an overhead
+            // byte, AND we have recieved the message terminator. This was a
+            // well framed message!
+            (Grab(0), 0x00) => (Ok(DataComplete), Idle),
+
+            // We have reached the end of a data run indicated by an overhead
+            // byte, and the next segment of 254 bytes will have no modified
+            // sentinel bytes
+            (Grab(0), 0xFF) => {
+                (Ok(DataContinue(0)), GrabChain(0xFE))
+            },
+
+            // We have reached the end of a data run indicated by an overhead
+            // byte, and we will treat this byte as a modified sentinel byte.
+            // place the sentinel byte in the output, and begin processing the
+            // next non-sentinel sequence
+            (Grab(0), n) => {
+                (Ok(DataContinue(0)), Grab(n - 1))
+            },
+
+            // We were not expecting the sequence to terminate, but here we are.
+            // Report an error due to early terminated message
+            (Grab(_), 0) => {
+                (Err(()), Idle)
+            }
+
+            // We have not yet reached the end of a data run, decrement the run
+            // counter, and place the byte into the decoded output
+            (Grab(i), n) =>  {
+                (Ok(DataContinue(n)), Grab(*i - 1))
+            },
+
+            // We have reached the end of a data run indicated by an overhead
+            // byte, AND we have recieved the message terminator. This was a
+            // well framed message!
+            (GrabChain(0), 0x00) => {
+                (Ok(DataComplete), Idle)
+            }
+
+            // We have reached the end of a data run, and we will begin another
+            // data run with an overhead byte expected at the end
+            (GrabChain(0), 0xFF) => (Ok(NoData), GrabChain(0xFE)),
+
+            // We have reached the end of a data run, and we will expect `n` data
+            // bytes unmodified, followed by a sentinel byte that must be modified
+            (GrabChain(0), n) => (Ok(NoData), Grab(n - 1)),
+
+            // We were not expecting the sequence to terminate, but here we are.
+            // Report an error due to early terminated message
+            (GrabChain(_), 0) => {
+                (Err(()), Idle)
+            }
+
+            // We have not yet reached the end of a data run, decrement the run
+            // counter, and place the byte into the decoded output
+            (GrabChain(i), n) => {
+                (Ok(DataContinue(n)), GrabChain(*i - 1))
+            },
+        };
+
+        *self = state;
+        ret
+    }
+}
+
+impl<'a> CobsDecoder<'a> {
+
+    /// Create a new streaming Cobs Decoder. Provide the output buffer
+    /// for the decoded message to be placed in
+    pub fn new(dest: &'a mut [u8]) -> CobsDecoder<'a> {
+        CobsDecoder {
+            dest,
+            dest_idx: 0,
+            state: DecoderState::Idle,
+        }
+    }
+
+    /// Push a single byte into the streaming CobsDecoder. Return values mean:
+    ///
+    /// * Ok(None) - State machine okay, more data needed
+    /// * Ok(Some(N)) - A message of N bytes was successfully decoded
+    /// * Err(M) - Message decoding failed, and M bytes were written to output
+    ///
+    /// NOTE: Sentinel value must be included in the input to this function for the
+    /// decoding to complete
+    pub fn feed(&mut self, data: u8) -> Result<Option<usize>, usize> {
+        match self.state.feed(data) {
+            Err(()) => Err(self.dest_idx),
+            Ok(DecodeResult::NoData) => Ok(None),
+            Ok(DecodeResult::DataContinue(n)) => {
+                add(self.dest, self.dest_idx, n).map_err(|_| self.dest_idx)?;
+                self.dest_idx += 1;
+                Ok(None)
+            }
+            Ok(DecodeResult::DataComplete) => {
+                Ok(Some(self.dest_idx))
+            }
+        }
+    }
+
+    /// Push a slice of bytes into the streaming CobsDecoder. Return values mean:
+    ///
+    /// * Ok(None) - State machine okay, more data needed
+    /// * Ok(Some((N, M))) - A message of N bytes was successfully decoded,
+    ///     using M bytes from `data` (and earlier data)
+    /// * Err(J) - Message decoding failed, and J bytes were written to output
+    ///
+    /// NOTE: Sentinel value must be included in the input to this function for the
+    /// decoding to complete
+    pub fn push(&mut self, data: &[u8]) -> Result<Option<(usize, usize)>, usize> {
+        for (consumed_idx, d) in data.iter().enumerate() {
+            let x = self.feed(*d);
+            if let Some(decoded_bytes_ct) = x? {
+                // convert from index to number of bytes consumed
+                return Ok(Some((decoded_bytes_ct, consumed_idx + 1)));
+            }
+        }
+
+        Ok(None)
+    }
+}
+
+// This needs to be a macro because `src` and `dst` could be the same or different.
+macro_rules! decode_raw (
+    ($src:ident, $dst:ident) => ({
+        let mut source_index = 0;
+        let mut dest_index = 0;
+
+        // Stop at the first terminator, if any
+        let src_end = if let Some(end) = $src.iter().position(|b| *b == 0) {
+            end
+        } else {
+            $src.len()
+        };
+
+        while source_index < src_end {
+            let code = $src[source_index];
+
+            if source_index + code as usize > src_end && code != 1 {
+                return Err(());
+            }
+
+            source_index += 1;
+
+            // TODO: There are potential `panic!`s in these dest_index offsets
+            for _ in 1..code {
+                $dst[dest_index] = $src[source_index];
+                source_index += 1;
+                dest_index += 1;
+            }
+
+            if 0xFF != code && source_index < src_end {
+                $dst[dest_index] = 0;
+                dest_index += 1;
+            }
+        }
+
+        DecodeReport {
+            dst_used: dest_index,
+            src_used: source_index,
+        }
+    })
+);
+
+/// Decodes the `source` buffer into the `dest` buffer.
+///
+/// This function uses the typical sentinel value of 0.
+///
+/// # Failures
+///
+/// This will return `Err(())` if there was a decoding error. Otherwise,
+/// it will return `Ok(n)` where `n` is the length of the decoded message.
+pub fn decode(source: &[u8], dest: &mut[u8]) -> Result<usize, ()> {
+    let mut dec = CobsDecoder::new(dest);
+
+    // Did we decode a message, using some or all of the buffer?
+    match dec.push(source).or(Err(()))? {
+        Some((d_used, _s_used)) => return Ok(d_used),
+        None => {},
+    }
+
+    // If we consumed the entire buffer, but did NOT get a message,
+    // AND the message did not end with a zero, try providing one to
+    // complete the decoding.
+    if source.last() != Some(&0) {
+        // Explicitly push sentinel of zero
+        if let Some((d_used, _s_used)) = dec.push(&[0]).or(Err(()))? {
+            return Ok(d_used)
+        }
+    }
+
+    // Nope, no early message, no missing terminator, just failed to decode
+    Err(())
+}
+
+/// A report of the source and destination bytes used during in-place decoding
+#[derive(Debug)]
+pub struct DecodeReport {
+    // The number of source bytes used, NOT INCLUDING the sentinel byte,
+    // if there was one.
+    pub src_used: usize,
+
+    // The number of bytes of the source buffer that now include the
+    // decoded result
+    pub dst_used: usize,
+}
+
+/// Decodes a message in-place.
+///
+/// This is the same function as `decode_in_place`, but provides a report
+/// of both the number of source bytes consumed as well as the size of the
+/// destination used.
+pub fn decode_in_place_report(buff: &mut[u8]) -> Result<DecodeReport, ()> {
+    Ok(decode_raw!(buff, buff))
+}
+
+/// Decodes a message in-place.
+///
+/// This is the same function as `decode`, but replaces the encoded message
+/// with the decoded message instead of writing to another buffer.
+///
+/// The returned `usize` is the number of bytes used for the DECODED value,
+/// NOT the number of source bytes consumed during decoding.
+pub fn decode_in_place(buff: &mut[u8]) -> Result<usize, ()> {
+    Ok(decode_raw!(buff, buff).dst_used)
+}
+
+/// Decodes the `source` buffer into the `dest` buffer using an arbitrary sentinel value.
+///
+/// This is done by XOR-ing each byte of the source message with the chosen sentinel value,
+/// which transforms the message into the same message encoded with a sentinel value of 0.
+/// Then the regular decoding transformation is performed.
+///
+/// The returned `usize` is the number of bytes used for the DECODED value,
+/// NOT the number of source bytes consumed during decoding.
+pub fn decode_with_sentinel(source: &[u8], dest: &mut[u8], sentinel: u8) -> Result<usize, ()> {
+    for (x, y) in source.iter().zip(dest.iter_mut()) {
+        *y = *x ^ sentinel;
+    }
+    decode_in_place(dest)
+}
+
+/// Decodes a message in-place using an arbitrary sentinel value.
+///
+/// The returned `usize` is the number of bytes used for the DECODED value,
+/// NOT the number of source bytes consumed during decoding.
+pub fn decode_in_place_with_sentinel(buff: &mut[u8], sentinel: u8) -> Result<usize, ()> {
+    for x in buff.iter_mut() {
+        *x ^= sentinel;
+    }
+    decode_in_place(buff)
+}
+
+#[cfg(feature = "use_std")]
+/// Decodes the `source` buffer into a vector.
+pub fn decode_vec(source: &[u8]) -> Result<Vec<u8>, ()> {
+    let mut decoded = vec![0; source.len()];
+    match decode(source, &mut decoded[..]) {
+        Ok(n) => {
+            decoded.truncate(n);
+            Ok(decoded)
+        },
+        Err(()) => Err(()),
+    }
+}
+
+#[cfg(feature = "use_std")]
+/// Decodes the `source` buffer into a vector with an arbitrary sentinel value.
+pub fn decode_vec_with_sentinel(source: &[u8], sentinel: u8) -> Result<Vec<u8>, ()> {
+    let mut decoded = vec![0; source.len()];
+    match decode_with_sentinel(source, &mut decoded[..], sentinel) {
+        Ok(n) => {
+            decoded.truncate(n);
+            Ok(decoded)
+        },
+        Err(()) => Err(()),
+    }
+}