Add protocol, clean code

Author: Sytten

body-plz/src/lib.rs

@@ -1,3 +1,2 @@
-#![allow(warnings)]
 pub mod body_struct;
 pub mod reader;

header-plz/src/lib.rs

@@ -1,4 +1,3 @@
-//#![allow(warnings)]
 pub mod abnf;
 pub mod body_headers;
 pub mod const_headers;

mime-plz/src/lib.rs

@@ -1,5 +1,3 @@
-//#![feature(test)]
-
 mod content_type;
-mod mime_type;
 pub use content_type::*;
+mod mime_type;

mime-plz/src/main.rs

@@ -0,0 +1,12 @@
+[package]
+name = "protocol_plz"
+version = "0.0.1"
+authors = ["darkseid", "sytten <emile@caido.io>"]
+description = "Protocol for the ParsePlz ecosystem"
+repository = "https://github.com/parseplz/primitives"
+license = "MIT"
+edition = "2024"
+
+[dependencies]
+buffer-plz = { path = "../buffer-plz", version = "0.0.1" }
+bytes = { workspace = true }

protocol-plz/Cargo.toml

@@ -0,0 +1,6 @@
+use bytes::BytesMut;
+
+// Trait to convert frame to bytesmut
+pub trait Frame {
+    fn into_data(self) -> BytesMut;
+}

protocol-plz/src/frame.rs

@@ -0,0 +1,4 @@
+mod frame;
+pub use frame::Frame;
+mod step;
+pub use step::Step;

protocol-plz/src/lib.rs

@@ -0,0 +1,43 @@
+use buffer::Event;
+
+use crate::frame::Frame;
+
+/* Description:
+ *      Trait to read a frame.
+ *
+ * Methods:
+ *      next()
+ *          Description : Process the event generated by IO to proceed with
+ *                        the next step.
+ *          Args        : Event
+ *          Returns     : Self
+ *          Errors      : StateError
+ *
+ *      is_ended()
+ *          Description : Check if a frame has been read.
+ *          Returns     : bool
+ *
+ *      get_frame()
+ *          Description : Consumes the state machine and returns the frame.
+ *          Returns     : T
+ *          Errors      : FrameError
+ *
+ *  Implementation:
+ *          OneOneState
+ */
+
+pub trait Step<T>
+where
+    T: Frame,
+{
+    type StateError;
+    type FrameError;
+
+    fn next(self, event: Event) -> Result<Self, Self::StateError>
+    where
+        Self: Sized;
+
+    fn is_ended(&self) -> bool;
+
+    fn into_frame(self) -> Result<T, Self::FrameError>;
+}