Prepare centralization of bstr as optional component

Author: Byron

README.md

@@ -201,6 +201,8 @@ All feature toggles are additive.
 
  * **with-serde**
    * Data structures implement `serde::Serialize` and `serde::Deserialize`
+ * **with-miniserde**
+   * Data structures implement `miniserde::Serialize` and `miniserde::Deserialize`
 
  The features above are provided by the crates
 

git-object/src/borrowed/commit.rs

@@ -4,7 +4,7 @@ use crate::borrowed::{
     util::{parse_header_field, parse_hex_sha1, parse_signature, NL},
     Signature,
 };
-use bstr::{BStr, ByteSlice};
+use crate::{ByteSlice, Bytes};
 use nom::{
     branch::alt,
     bytes::{complete::is_not, complete::tag},
@@ -17,18 +17,18 @@ use smallvec::SmallVec;
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 pub struct Commit<'data> {
     // SHA1 of tree object we point to
-    pub tree: &'data BStr,
+    pub tree: &'data Bytes,
     // SHA1 of each parent commit. Empty for first commit in repository.
-    pub parents: SmallVec<[&'data BStr; 1]>,
+    pub parents: SmallVec<[&'data Bytes; 1]>,
     pub author: Signature<'data>,
     pub committer: Signature<'data>,
     // The name of the message encoding, otherwise UTF-8 should be assumed.
-    pub encoding: Option<&'data BStr>,
-    pub message: &'data BStr,
-    pub pgp_signature: Option<&'data BStr>,
+    pub encoding: Option<&'data Bytes>,
+    pub message: &'data Bytes,
+    pub pgp_signature: Option<&'data Bytes>,
 }
 
-pub fn parse_message(i: &[u8]) -> IResult<&[u8], &BStr, Error> {
+pub fn parse_message(i: &[u8]) -> IResult<&[u8], &Bytes, Error> {
     if i.is_empty() {
         // newline + [message]
         return Err(nom::Err::Error(Error::NomDetail(i.into(), "commit message is missing")));

git-object/src/borrowed/object/error.rs

@@ -3,14 +3,14 @@ use quick_error::quick_error;
 quick_error! {
     #[derive(Debug)]
     pub enum Error {
-        ParseIntegerError(msg: &'static str, number: bstr::BString, err: btoi::ParseIntegerError) {
+        ParseIntegerError(msg: &'static str, number: crate::BytesOwned, err: btoi::ParseIntegerError) {
             display("{}: {:?}", msg, number)
             cause(err)
         }
         Nom(err_msg: String) {
             display("{}", err_msg)
         }
-        NomDetail(input: bstr::BString, msg: &'static str) {
+        NomDetail(input: crate::BytesOwned, msg: &'static str) {
             display("{}: '{}' could not be parsed", msg, input)
         }
         ParseKindError(err: crate::types::Error) {

git-object/src/borrowed/object/mod.rs

@@ -1,17 +1,17 @@
 mod error;
 pub use error::Error;
 
+use crate::Bytes;
 use crate::{
     borrowed,
     borrowed::{Blob, Commit, Tag, Tree},
     Time,
 };
-use bstr::BStr;
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 pub struct Signature<'data> {
-    pub name: &'data BStr,
-    pub email: &'data BStr,
+    pub name: &'data Bytes,
+    pub email: &'data Bytes,
     pub time: Time,
 }
 

git-object/src/borrowed/tag.rs

@@ -3,7 +3,7 @@ use crate::borrowed::{
     util::{parse_header_field, parse_hex_sha1, parse_signature, NL},
     Signature,
 };
-use bstr::{BStr, ByteSlice};
+use crate::{ByteSlice, Bytes};
 use nom::{
     branch::alt,
     bytes::complete::{tag, take_until, take_while1},
@@ -18,13 +18,13 @@ use nom::{
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 pub struct Tag<'data> {
     // Target SHA1 in hex, always 40 lower case characters from 0-9 and a-f
-    pub target: &'data BStr,
+    pub target: &'data Bytes,
     // The name of the tag, e.g. "v1.0"
-    pub name: &'data BStr,
+    pub name: &'data Bytes,
     pub target_kind: crate::Kind,
-    pub message: &'data BStr,
+    pub message: &'data Bytes,
     pub signature: Signature<'data>,
-    pub pgp_signature: Option<&'data BStr>,
+    pub pgp_signature: Option<&'data Bytes>,
 }
 
 fn parse(i: &[u8]) -> IResult<&[u8], Tag, Error> {
@@ -54,7 +54,7 @@ fn parse(i: &[u8]) -> IResult<&[u8], Tag, Error> {
     ))
 }
 
-fn parse_message(i: &[u8]) -> IResult<&[u8], (&BStr, Option<&BStr>), Error> {
+fn parse_message(i: &[u8]) -> IResult<&[u8], (&Bytes, Option<&Bytes>), Error> {
     const PGP_SIGNATURE_BEGIN: &[u8] = b"\n-----BEGIN PGP SIGNATURE-----";
     const PGP_SIGNATURE_END: &[u8] = b"-----END PGP SIGNATURE-----";
 

git-object/src/borrowed/tree.rs

@@ -1,5 +1,5 @@
 use crate::{borrowed::util::SPACE, borrowed::Error};
-use bstr::{BStr, ByteSlice};
+use crate::{ByteSlice, Bytes};
 use nom::{
     bytes::complete::{tag, take, take_while1, take_while_m_n},
     character::is_digit,
@@ -18,7 +18,7 @@ pub struct Tree<'data> {
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
 pub struct Entry<'data> {
     pub mode: Mode,
-    pub filename: &'data BStr,
+    pub filename: &'data Bytes,
     // 20 bytes SHA1
     pub oid: &'data [u8],
 }

git-object/src/borrowed/util/mod.rs

@@ -1,6 +1,7 @@
-use crate::borrowed::{Error, Signature};
-use crate::{Sign, Time};
-use bstr::{BStr, ByteSlice};
+use crate::{
+    borrowed::{Error, Signature},
+    ByteSlice, Bytes, Sign, Time,
+};
 use btoi::btoi;
 use nom::{
     branch::alt,
@@ -46,7 +47,7 @@ fn is_hex_digit_lc(b: u8) -> bool {
     }
 }
 
-pub(crate) fn parse_hex_sha1(i: &[u8]) -> IResult<&[u8], &BStr, Error> {
+pub(crate) fn parse_hex_sha1(i: &[u8]) -> IResult<&[u8], &Bytes, Error> {
     take_while_m_n(40usize, 40, is_hex_digit_lc)(i).map(|(i, o)| (i, o.as_bstr()))
 }
 

git-object/src/borrowed/util/tests.rs

@@ -1,8 +1,8 @@
 mod parse_signature {
     use crate::borrowed::util::parse_signature;
     use crate::borrowed::Signature;
+    use crate::ByteSlice;
     use crate::{Sign, Time};
-    use bstr::ByteSlice;
 
     fn signature(name: &'static str, email: &'static str, time: u32, sign: Sign, offset: i32) -> Signature<'static> {
         Signature {

git-object/src/lib.rs

@@ -1,5 +1,9 @@
 #![forbid(unsafe_code)]
 
+pub type BytesOwned = bstr::BString;
+pub type Bytes = bstr::BStr;
+pub use bstr::ByteSlice;
+
 pub mod borrowed;
 mod types;
 

git-object/src/types.rs

@@ -1,13 +1,11 @@
-use bstr::ByteSlice;
-use nom::lib::std::fmt::Formatter;
-use nom::lib::std::ops::Deref;
+use crate::ByteSlice;
+use nom::{lib::std::fmt::Formatter, lib::std::ops::Deref};
 use quick_error::quick_error;
 
-#[cfg(feature = "with-serde")]
-use serde::{Deserialize, Serialize};
-
 #[cfg(feature = "with-miniserde")]
 use miniserde::{Deserialize as MiniDeserialize, Serialize as MiniSerialize};
+#[cfg(feature = "with-serde")]
+use serde::{Deserialize, Serialize};
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
 #[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
@@ -93,7 +91,7 @@ pub enum Kind {
 quick_error! {
     #[derive(Debug)]
     pub enum Error {
-        InvalidObjectKind(kind: bstr::BString) {
+        InvalidObjectKind(kind: crate::BytesOwned) {
             display("Unknown object kind: {:?}", std::str::from_utf8(&kind))
         }
     }