Add bitsLeft to BitReader protocol and make it public

Author: tsolomko

Sources/BitReader.swift

@@ -11,6 +11,9 @@ public protocol BitReader: class {
     /// True, if reader's BIT pointer is aligned with the BYTE border.
     var isAligned: Bool { get }
 
+    // Amount of bits left to read.
+    var bitsLeft: Int { get }
+
     /// Creates an instance for reading bits (and bytes) from `data`.
     init(data: Data)
 

Sources/LsbBitReader.swift

@@ -11,7 +11,13 @@ public final class LsbBitReader: ByteReader, BitReader {
     private var bitMask: UInt8 = 1
     private var currentByte: UInt8
 
-    private var bitsLeft: Int {
+    /// True, if reader's BIT pointer is aligned with the BYTE border.
+    public var isAligned: Bool {
+        return self.bitMask == 1
+    }
+
+    // Amount of bits left to read.
+    public var bitsLeft: Int {
         if isFinished {
             return 0
         } else {
@@ -27,19 +33,14 @@ public final class LsbBitReader: ByteReader, BitReader {
 
     /**
      Converts a `ByteReader` instance into `LsbBitReader`, enabling bits reading capabilities.
-     Current `offset` value in `byteReader` is preserved.
+     Current `offset` value of `byteReader` is preserved.
      */
     public init(_ byteReader: ByteReader) {
         self.currentByte = byteReader.offset < byteReader.data.endIndex ? byteReader.data[byteReader.offset] : 0
         super.init(data: byteReader.data)
         self.offset = byteReader.offset
     }
 
-    /// True, if reader's BIT pointer is aligned with the BYTE border.
-    public var isAligned: Bool {
-        return self.bitMask == 1
-    }
-
     /**
      Reads bit and returns it, advancing by one BIT position.
 

Sources/MsbBitReader.swift

@@ -11,7 +11,13 @@ public final class MsbBitReader: ByteReader, BitReader {
     private var bitMask: UInt8 = 128
     private var currentByte: UInt8
 
-    private var bitsLeft: Int {
+    /// True, if reader's BIT pointer is aligned with the BYTE border.
+    public var isAligned: Bool {
+        return self.bitMask == 128
+    }
+
+    // Amount of bits left to read.
+    public var bitsLeft: Int {
         if isFinished {
             return 0
         } else {
@@ -27,19 +33,14 @@ public final class MsbBitReader: ByteReader, BitReader {
 
     /**
      Converts a `ByteReader` instance into `MsbBitReader`, enabling bit reading capabilities.
-     Current `offset` value in `byteReader` is preserved.
+     Current `offset` value of `byteReader` is preserved.
      */
     public init(_ byteReader: ByteReader) {
         self.currentByte = byteReader.offset < byteReader.data.endIndex ? byteReader.data[byteReader.offset] : 0
         super.init(data: byteReader.data)
         self.offset = byteReader.offset
     }
 
-    /// True, if reader's BIT pointer is aligned with the BYTE border.
-    public var isAligned: Bool {
-        return self.bitMask == 128
-    }
-
     /**
      Reads bit and returns it, advancing by one BIT position.