Builder for sections 1 & 3 (#8)

* Section3 builder

* Dependency on derive_builder

* Split Error in a module

* Moving Section1 to a module by itself

* Temporary fix

* Test everything

* Cleanning

Don't need it in the core library but only in the module.

* Some general info, but still incomplete

* Patch upgrade

Skeleton for a builder.

.github/workflows/ci.yml

@@ -57,7 +57,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --no-fail-fast
+          args: --no-fail-fast --workspace
 
   coverage:
     runs-on: ubuntu-latest

Cargo.toml

@@ -1,4 +1,7 @@
 [workspace]
 members = [ "bufr-lib", "bufr-dump"]
 
+[workspace.package]
+version = "0.1.3"
+
 default-members = [ "bufr-lib" ]

README.md

@@ -5,3 +5,24 @@
 
 A BUFR parser for humans. Sometimes we just want to check one certain metadata
 of a file.
+
+## Minimum supported Rust version
+
+Currently the minimum supported Rust version is 1.69.0
+
+## 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.

bufr-lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bufr"
-version = "0.1.2"
+version.workspace = true
 authors = ["Luiz Irber <luiz.irber@gmail.com>", "Guilherme Castelão <guilherme@castelao.net>"]
 edition = "2018"
 description = "BUFR is binary data format defined by WMO focused on real-time data."
@@ -13,6 +13,7 @@ repository = "https://github.com/castelao/BUFR"
 [dependencies]
 bitreader="0.3"
 csv="1.1"
+derive_builder = "0.12.0"
 thiserror = "1.0"
 getset = "0.1.1"
 serde = { version = "1.0.125", features = ["derive"] }

bufr-lib/src/error.rs

@@ -0,0 +1,40 @@
+//#![deny(missing_docs)]
+
+/// Possible errors when parsing BUFR messages
+#[derive(Debug, thiserror::Error)]
+pub enum Error {
+    /// Message too short to even contain the total size
+    #[error("BUFR message is too short, less than 8 bytes")]
+    MessageTooShort,
+
+    /// Wrong magic number
+    #[error("BUFR message should start with BUFR")]
+    MagicNumber,
+
+    /// Wrong end section
+    #[error("BUFR message should end with 7777")]
+    EndSection,
+
+    /// Message shorter than specified on section 0
+    #[error("Message shorter than expected, is it truncated?")]
+    TruncatedMessage,
+
+    /// BUFR version not supported
+    #[error("BUFR version {0} not supported")]
+    VersionNotSupported(u8),
+
+    /*
+    /// Number of descriptors doesn't match the size
+    #[error("Expected {n_descriptors} descriptors, requiring {descriptor_size}B but buffer size {buffer_size}B")]
+    WrongNumberOfDescriptors {
+        n_descriptors: u16,
+        descriptor_size: usize,
+        buffer_size: usize,
+    },
+    */
+    #[error("Section 3 must be larger than 7 and an odd number, got {0}")]
+    InvalidSection3Length(usize),
+
+    #[error(transparent)]
+    IOError(#[from] std::io::Error),
+}