refactor: Refactor examples

Author: jakoschiko

imap-codec/examples/client.rs

@@ -0,0 +1,79 @@
+use imap_codec::{fragmentizer::Fragmentizer, GreetingCodec};
+
+#[path = "common/common.rs"]
+mod common;
+
+use common::read_more;
+
+use crate::common::Role;
+
+enum State {
+    Greeting,
+    Response,
+}
+
+const WELCOME: &str = r#"# Parsing of IMAP greeting and responses
+
+"S:" denotes the server.
+
+Note: "\n" will be automatically replaced by "\r\n".
+
+--------------------------------------------------------------------------------------------------
+
+Enter intial IMAP greeting followed by IMAP responses (or "exit").
+"#;
+
+fn main() {
+    println!("{}", WELCOME);
+
+    let mut buffer = Vec::new();
+    let mut fragmentizer = Fragmentizer::new(10 * 1024);
+    let mut state = State::Greeting;
+
+    loop {
+        // Progress next message.
+        fragmentizer.progress();
+
+        // Does the Fragmentizer need more bytes?
+        if fragmentizer.is_message_complete() {
+            // Read more bytes ...
+            read_more(&mut buffer, Role::Server);
+
+            // ... and pass the bytes to the Fragmentizer ...
+            fragmentizer.enqueue_bytes(&buffer);
+            buffer.clear();
+
+            // ... and try again.
+            continue;
+        }
+
+        // The Fragmentizer detected a complete message.
+        match state {
+            State::Greeting => {
+                match fragmentizer.decode_message(&GreetingCodec::default()) {
+                    Ok(greeting) => {
+                        // Do something with the greeting ...
+                        println!("{:#?}", greeting);
+
+                        // ... and proceed with reponses.
+                        state = State::Response;
+                    }
+                    Err(err) => {
+                        println!("Error parsing greeting: {err:?}");
+                    }
+                };
+            }
+            State::Response => {
+                match fragmentizer.decode_message(&GreetingCodec::default()) {
+                    Ok(response) => {
+                        // Do something with the response.
+                        println!("{:#?}", response);
+                    }
+                    Err(err) => {
+                        println!("Error parsing response: {err:?}");
+                    }
+                };
+            }
+        };
+    }
+}

imap-codec/examples/server.rs

@@ -0,0 +1,78 @@
+use imap_codec::{
+    decode::{CommandDecodeError, Decoder},
+    fragmentizer::{FragmentInfo, Fragmentizer},
+    CommandCodec,
+};
+
+#[path = "common/common.rs"]
+mod common;
+
+use common::{read_more, COLOR_SERVER, RESET};
+
+use crate::common::Role;
+
+const WELCOME: &str = r#"# Parsing of IMAP commands
+
+"C:" denotes the client,
+"S:" denotes the server, and
+".." denotes the continuation of an (incomplete) command, e.g., due to the use of an IMAP literal.
+
+Note: "\n" will be automatically replaced by "\r\n".
+
+--------------------------------------------------------------------------------------------------
+
+Enter IMAP commands (or "exit").
+"#;
+
+fn main() {
+    println!("{}", WELCOME);
+
+    let mut buffer = Vec::new();
+    let mut fragmentizer = Fragmentizer::new(10 * 1024);
+
+    // Simulate a greeting.
+    println!("S: {COLOR_SERVER}* OK ...{RESET}");
+
+    loop {
+        // Progress next message.
+        let fragment_info = fragmentizer.progress();
+
+        // The Fragmentizer detected a line that announces a literal.
+        // A command continuation request is expected.
+        if let Some(FragmentInfo::Line {
+            announcement: Some(_),
+            ..
+        }) = fragment_info
+        {
+            // Simulate a command continuation request ...
+            println!("S: {COLOR_SERVER}+ {RESET}");
+
+            // ... and continue with the remaining message.
+            continue;
+        }
+
+        // Does the Fragmentizer need more bytes?
+        if fragmentizer.is_message_complete() {
+            // Read more bytes ...
+            read_more(&mut buffer, Role::Server);
+
+            // ... and pass the bytes to the Fragmentizer ...
+            fragmentizer.enqueue_bytes(&buffer);
+            buffer.clear();
+
+            // ... and try again.
+            continue;
+        }
+
+        // The Fragmentizer detected a complete message.
+        match fragmentizer.decode_message(&CommandCodec::default()) {
+            Ok(command) => {
+                // Do something with the command.
+                println!("{:#?}", command);
+            }
+            Err(err) => {
+                println!("Error parsing command: {err:?}");
+            }
+        };
+    }
+}