feat: expose Buffer type needed for codegen (#184)

* Expose Buffer needed for generated FIX definitions

* Remove remaining traces of fefix references in code

Author: davidsteiner

Cargo.lock

@@ -23,4 +23,4 @@ indoc = "2"
 
 [dev-dependencies]
 hotfix-dictionary = { version = "0.0.26", path = "../hotfix-dictionary", features = ["fix40", "fix41", "fix42", "fix43", "fix50"] }
-syn = { version = "2", features = ["parsing"] }
+syn = { version = "2", features = ["full", "parsing"] }

crates/hotfix-codegen/Cargo.toml

@@ -4,7 +4,7 @@ use hotfix_dictionary::{self as dict, TagU32};
 use indoc::indoc;
 use std::marker::PhantomData;
 
-const FEFIX_VERSION: &str = env!("CARGO_PKG_VERSION");
+const HOTFIX_VERSION: &str = env!("CARGO_PKG_VERSION");
 
 /// Creates a [`String`] that contains a multiline Rust "Doc" comment explaining
 /// that all subsequent code was automatically generated.
@@ -14,21 +14,21 @@ const FEFIX_VERSION: &str = env!("CARGO_PKG_VERSION");
 /// leading whitespace.
 ///
 /// ```text
-/// // Generated automatically by FerrumFIX. Do not modify manually.
+/// // Generated automatically by HotFIX. Do not modify manually.
 /// ```
 pub fn generated_code_notice() -> String {
     use chrono::prelude::*;
 
     format!(
         indoc!(
             r#"
-            // Generated automatically by FerrumFIX {} on {}.
+            // Generated automatically by HotFIX {} on {}.
             //
             // DO NOT MODIFY MANUALLY.
             // DO NOT COMMIT TO VERSION CONTROL.
             // ALL CHANGES WILL BE OVERWRITTEN."#
         ),
-        FEFIX_VERSION,
+        HOTFIX_VERSION,
         Utc::now().to_rfc2822(),
     )
 }
@@ -102,8 +102,8 @@ pub struct Settings {
     pub indentation: String,
     /// The indentation level of all generated Rust code. Zero by default.
     pub indentation_depth: u32,
-    /// The name of the `fefix` crate for imports. `fefix` by default.
-    pub fefix_crate_name: String,
+    /// The name of the `hotfix` crate for imports. `hotfix` by default.
+    pub hotfix_crate_name: String,
     /// A list of derive macros on top of all generated FIX datatype `enum`s. E.g.:
     ///
     /// ```
@@ -147,7 +147,7 @@ impl Default for Settings {
                 "FieldType".to_string(),
             ],
             attributes_for_allowed_values: vec![],
-            fefix_crate_name: "hotfix".to_string(),
+            hotfix_crate_name: "hotfix".to_string(),
             phantom: PhantomData,
         }
     }
@@ -214,9 +214,9 @@ pub fn gen_definitions(fix_dictionary: &dict::Dictionary, settings: &Settings) -
 
             // {top_comment}
 
-            use {fefix_path}::dict::FieldLocation;
-            use {fefix_path}::dict::FixDatatype;
-            use {fefix_path}::{{FieldType, HardCodedFixFieldDefinition}};
+            use {hotfix_path}::dict::FieldLocation;
+            use {hotfix_path}::dict::FixDatatype;
+            use {hotfix_path}::{{FieldType, HardCodedFixFieldDefinition}};
 
             {enum_definitions}
 
@@ -226,7 +226,7 @@ pub fn gen_definitions(fix_dictionary: &dict::Dictionary, settings: &Settings) -
         top_comment = top_comment,
         enum_definitions = enums,
         field_defs = field_defs,
-        fefix_path = settings.fefix_crate_name,
+        hotfix_path = settings.hotfix_crate_name,
     );
     code
 }

crates/hotfix-codegen/src/lib.rs

@@ -36,9 +36,9 @@ pub fn derive_fix_value(input: TokenStream) -> TokenStream {
         })
         .take_enum()
         .expect("Invalid enum");
-    let fefix_crate_info =
+    let hotfix_crate_info =
         proc_macro_crate::crate_name("hotfix-message").expect("Cargo.toml hotfix issues");
-    let fefix_crate_name = match fefix_crate_info {
+    let hotfix_crate_name = match hotfix_crate_info {
         proc_macro_crate::FoundCrate::Itself => Ident::new("crate", Span::call_site()),
         proc_macro_crate::FoundCrate::Name(s) => Ident::new(s.as_str(), Span::call_site()),
     };
@@ -49,7 +49,7 @@ pub fn derive_fix_value(input: TokenStream) -> TokenStream {
 
             fn serialize_with<B>(&self, buffer: &mut B, _settings: Self::SerializeSettings) -> usize
             where
-                B: #fefix_crate_name::Buffer,
+                B: #hotfix_crate_name::Buffer,
             {
                 match self {
                     #(#matching_cases)*
@@ -70,13 +70,13 @@ pub fn derive_fix_value(input: TokenStream) -> TokenStream {
 #[derive(Debug, Clone, FromVariant)]
 #[darling(attributes(hotfix))]
 struct EnumVariantInfo {
-    ident: syn::Ident,
+    ident: Ident,
     variant: String,
 }
 
 #[derive(Debug, Clone, FromDeriveInput)]
 #[darling(attributes(hotfix))]
 struct DataFieldWithVariants {
-    ident: syn::Ident,
+    ident: Ident,
     data: darling::ast::Data<EnumVariantInfo, darling::util::Ignored>,
 }

crates/hotfix-derive/src/derive_fix_value.rs

@@ -1,4 +1,4 @@
-//! Derive macros for FerrumFIX.
+//! Derive macros for HotFIX.
 
 #![deny(missing_debug_implementations, clippy::useless_conversion)]
 

crates/hotfix-derive/src/lib.rs

@@ -1,7 +1,7 @@
 [package]
 name = "hotfix-message"
 description = "FIX messages for HotFIX."
-version.workspace = true
+version = "0.1.0"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

crates/hotfix-message/Cargo.toml

@@ -23,7 +23,7 @@ fn codegen(fix_dictionary: Dictionary, filename: &str) -> io::Result<()> {
     // writing.
     let dir = PathBuf::from(var("OUT_DIR").unwrap());
     let codegen_settings = &mut codegen::Settings::default();
-    codegen_settings.fefix_crate_name = "crate".to_string();
+    codegen_settings.hotfix_crate_name = "crate".to_string();
     let code = codegen::gen_definitions(&fix_dictionary, codegen_settings);
     let path = dir.join(filename);
     let file = &mut File::create(path)?;

crates/hotfix-message/build.rs

@@ -1,9 +1,9 @@
 /// Operations on a growable in-memory buffer.
 ///
-/// This trait is intented to be used as a thin compatibility layer between
+/// This trait is intended to be used as a thin compatibility layer between
 /// [`Vec<u8>`] and
 /// [`bytes::BytesMut`](https://docs.rs/bytes/1.1.0/bytes/struct.BytesMut.html).
-/// By writing generic code that operates on [`Buffer`], FerrumFIX users can
+/// By writing generic code that operates on [`Buffer`], HotFIX users can
 /// decide for themselves if they want to use `bytes` and still use most of the
 /// features.
 ///
@@ -23,6 +23,12 @@ pub trait Buffer {
         self.as_slice().len()
     }
 
+    /// Returns `true` if the buffer is empty.
+    #[inline]
+    fn is_empty(&self) -> bool {
+        self.len() == 0
+    }
+
     /// Returns the number of bytes that `self` can hold without reallocating.
     fn capacity(&self) -> usize;
 

crates/hotfix-message/src/encoding/buffer.rs

@@ -2,7 +2,7 @@
 //!
 //! # What is this and why is this necessary?
 //!
-//! FerrumFIX internals rely on [`Dictionary`](crate::Dictionary) for accessing
+//! HotFIX internals rely on [`Dictionary`](crate::Dictionary) for accessing
 //! details about fields, messages and other abstract entities defined in the
 //! FIX Dictionary specifications. Although this approach works quite well, it
 //! can become daunting to query a [`Dictionary`](crate::Dictionary) for even

crates/hotfix-message/src/encoding/definitions.rs

@@ -8,7 +8,7 @@ mod parser;
 pub(crate) mod parts;
 mod tags;
 
-use encoding::Buffer;
+pub use encoding::Buffer;
 pub use encoding::HardCodedFixFieldDefinition;
 pub use encoding::field_access::FieldType;
 pub use encoding::field_types;