1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
//! # Sans-IO Protocol Framework
//!
//! A lightweight, zero-dependency framework for building protocol implementations that are
//! completely decoupled from I/O operations.
//!
//! ## What is Sans-IO?
//!
//! Sans-IO (French for "without I/O") is an architectural pattern that separates protocol logic
//! from I/O handling. This separation provides several key benefits:
//!
//! - **Testability**: Protocol logic can be tested without mocking sockets or async runtimes
//! - **Portability**: Same protocol works in sync, async, embedded, or WASM environments
//! - **Composability**: Multiple protocol layers can be easily stacked and combined
//! - **Debuggability**: State machines can be inspected without I/O side effects
//!
//! ## no_std Support
//!
//! This crate is `no_std` by default and works in any environment - embedded systems,
//! WASM, or standard applications.
//!
//! ### Time Handling
//!
//! The `Time` associated type is fully generic, allowing you to use any time representation:
//!
//! - **With std**: Use `std::time::Instant` or `std::time::SystemTime`
//! - **Embedded/bare-metal**: Use `u64` for tick counts, `i64` for milliseconds, or custom time types
//! - **No timeouts**: Use `()` (unit type) when timeout handling isn't needed
//!
//! This flexibility means timeout functionality works everywhere - you just choose the
//! appropriate time type for your platform.
//!
//! ## The Protocol Trait
//!
//! The [`Protocol`] trait provides a push-pull API for handling messages:
//!
//! - **Push API** (`handle_*`): Push data/events into the protocol
//! - **Pull API** (`poll_*`): Poll results from the protocol
//!
//! This design enables complete I/O independence while maintaining a clean, intuitive interface.
//!
//! ### Type Parameters
//!
//! - `Rin`: Input read message type (what you push in for reading)
//! - `Win`: Input write message type (what you push in for writing)
//! - `Ein`: Input event type (custom events specific to your protocol)
//!
//! ### Associated Types
//!
//! - `Rout`: Output read message type (what you poll after reading)
//! - `Wout`: Output write message type (what you poll after writing)
//! - `Eout`: Output event type (events generated by the protocol)
//! - `Error`: Error type for operations
//! - `Time`: Time/instant type for timeout handling (can be `Instant`, `u64`, `i64`, `()`, etc.)
//!
//! ## Basic Example
//!
//! ```rust
//! use sansio::Protocol;
//! # extern crate std;
//! # use std::collections::VecDeque;
//!
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! #
//! /// A simple uppercase protocol: converts incoming strings to uppercase
//! struct UppercaseProtocol {
//! routs: VecDeque<String>,
//! wouts: VecDeque<String>,
//! }
//!
//! impl UppercaseProtocol {
//! fn new() -> Self {
//! Self {
//! routs: VecDeque::new(),
//! wouts: VecDeque::new(),
//! }
//! }
//! }
//!
//! impl Protocol<String, String, ()> for UppercaseProtocol {
//! type Rout = String;
//! type Wout = String;
//! type Eout = ();
//! type Error = MyError;
//! type Time = (); // No timeout handling needed
//!
//! fn handle_read(&mut self, msg: String) -> Result<(), Self::Error> {
//! // Process incoming message
//! self.routs.push_back(msg.to_uppercase());
//! Ok(())
//! }
//!
//! fn poll_read(&mut self) -> Option<Self::Rout> {
//! // Return processed message
//! self.routs.pop_front()
//! }
//!
//! fn handle_write(&mut self, msg: String) -> Result<(), Self::Error> {
//! // For this simple protocol, just pass through
//! self.wouts.push_back(msg);
//! Ok(())
//! }
//!
//! fn poll_write(&mut self) -> Option<Self::Wout> {
//! self.wouts.pop_front()
//! }
//! }
//!
//! // Usage
//! let mut protocol = UppercaseProtocol::new();
//!
//! // Push data in
//! protocol.handle_read("hello".to_string()).unwrap();
//!
//! // Pull results out
//! assert_eq!(protocol.poll_read(), Some("HELLO".to_string()));
//! ```
//!
//! ## Timeout Handling Example
//!
//! Protocols can handle time-based operations like heartbeats or retransmissions.
//!
//! ### Using std::time::Instant
//!
//! ```rust
//! # extern crate std;
//! use sansio::Protocol;
//! use std::time::{Duration, Instant};
//!
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! #
//! /// A protocol that sends periodic heartbeats
//! struct HeartbeatProtocol {
//! next_heartbeat: Option<Instant>,
//! heartbeat_interval: Duration,
//! pending_write: Option<Vec<u8>>,
//! }
//!
//! impl HeartbeatProtocol {
//! fn new(interval: Duration) -> Self {
//! Self {
//! next_heartbeat: None,
//! heartbeat_interval: interval,
//! pending_write: None,
//! }
//! }
//! }
//!
//! impl Protocol<Vec<u8>, Vec<u8>, ()> for HeartbeatProtocol {
//! type Rout = Vec<u8>;
//! type Wout = Vec<u8>;
//! type Eout = ();
//! type Error = MyError;
//! type Time = Instant; // Using std::time::Instant
//!
//! fn handle_read(&mut self, msg: Vec<u8>) -> Result<(), Self::Error> {
//! // Reset heartbeat timer on any received message
//! self.next_heartbeat = Some(Instant::now() + self.heartbeat_interval);
//! Ok(())
//! }
//!
//! fn poll_read(&mut self) -> Option<Self::Rout> {
//! None
//! }
//!
//! fn handle_write(&mut self, msg: Vec<u8>) -> Result<(), Self::Error> {
//! self.pending_write = Some(msg);
//! Ok(())
//! }
//!
//! fn poll_write(&mut self) -> Option<Self::Wout> {
//! self.pending_write.take()
//! }
//!
//! fn handle_timeout(&mut self, now: Instant) -> Result<(), Self::Error> {
//! // Send heartbeat
//! self.pending_write = Some(b"HEARTBEAT".to_vec());
//! self.next_heartbeat = Some(now + self.heartbeat_interval);
//! Ok(())
//! }
//!
//! fn poll_timeout(&mut self) -> Option<Instant> {
//! self.next_heartbeat
//! }
//! }
//! ```
//!
//! ### Using tick counts (no_std friendly)
//!
//! ```rust
//! use sansio::Protocol;
//! # extern crate std;
//! # use std::collections::VecDeque;
//!
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! #
//! /// A protocol with timeout using tick counts (no_std friendly)
//! struct TickProtocol {
//! next_timeout_tick: Option<u64>,
//! timeout_interval: u64,
//! messages: VecDeque<Vec<u8>>,
//! }
//!
//! impl TickProtocol {
//! fn new(timeout_interval: u64) -> Self {
//! Self {
//! next_timeout_tick: None,
//! timeout_interval,
//! messages: VecDeque::new(),
//! }
//! }
//! }
//!
//! impl Protocol<Vec<u8>, Vec<u8>, ()> for TickProtocol {
//! type Rout = Vec<u8>;
//! type Wout = Vec<u8>;
//! type Eout = ();
//! type Error = MyError;
//! type Time = u64; // Using tick counts for embedded systems
//!
//! fn handle_read(&mut self, msg: Vec<u8>) -> Result<(), Self::Error> {
//! self.messages.push_back(msg);
//! Ok(())
//! }
//!
//! fn poll_read(&mut self) -> Option<Self::Rout> {
//! self.messages.pop_front()
//! }
//!
//! fn handle_write(&mut self, msg: Vec<u8>) -> Result<(), Self::Error> {
//! self.messages.push_back(msg);
//! Ok(())
//! }
//!
//! fn poll_write(&mut self) -> Option<Self::Wout> {
//! self.messages.pop_front()
//! }
//!
//! fn handle_timeout(&mut self, current_tick: u64) -> Result<(), Self::Error> {
//! // Handle timeout at current tick
//! self.next_timeout_tick = Some(current_tick + self.timeout_interval);
//! Ok(())
//! }
//!
//! fn poll_timeout(&mut self) -> Option<u64> {
//! self.next_timeout_tick
//! }
//! }
//! ```
//!
//! ## Event Handling Example
//!
//! Protocols can generate and handle custom events:
//!
//! ```rust
//! use sansio::Protocol;
//! # extern crate std;
//! # use std::collections::VecDeque;
//!
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! #
//! /// Custom event types
//! #[derive(Debug, PartialEq)]
//! enum ConnectionEvent {
//! Connected,
//! Disconnected,
//! Error(String),
//! }
//!
//! /// Protocol that tracks connection state
//! struct ConnectionProtocol {
//! connected: bool,
//! event_queue: VecDeque<ConnectionEvent>,
//! }
//!
//! impl ConnectionProtocol {
//! fn new() -> Self {
//! Self {
//! connected: false,
//! event_queue: VecDeque::new(),
//! }
//! }
//! }
//!
//! impl Protocol<String, String, ConnectionEvent> for ConnectionProtocol {
//! type Rout = String;
//! type Wout = String;
//! type Eout = ConnectionEvent;
//! type Error = MyError;
//! type Time = (); // No timeout needed
//!
//! fn handle_read(&mut self, msg: String) -> Result<(), Self::Error> {
//! Ok(())
//! }
//!
//! fn poll_read(&mut self) -> Option<Self::Rout> {
//! None
//! }
//!
//! fn handle_write(&mut self, msg: String) -> Result<(), Self::Error> {
//! Ok(())
//! }
//!
//! fn poll_write(&mut self) -> Option<Self::Wout> {
//! None
//! }
//!
//! fn handle_event(&mut self, evt: ConnectionEvent) -> Result<(), Self::Error> {
//! match evt {
//! ConnectionEvent::Connected => {
//! self.connected = true;
//! self.event_queue.push_back(ConnectionEvent::Connected);
//! }
//! ConnectionEvent::Disconnected => {
//! self.connected = false;
//! self.event_queue.push_back(ConnectionEvent::Disconnected);
//! }
//! ConnectionEvent::Error(msg) => {
//! self.event_queue.push_back(ConnectionEvent::Error(msg));
//! }
//! }
//! Ok(())
//! }
//!
//! fn poll_event(&mut self) -> Option<Self::Eout> {
//! self.event_queue.pop_front()
//! }
//! }
//! ```
//!
//! ## Protocol Composition
//!
//! Protocols can be layered and composed. Here's a simple example of wrapping one protocol
//! with another:
//!
//! ```rust
//! use sansio::Protocol;
//!
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! #
//! /// A protocol wrapper that logs all messages
//! struct LoggingWrapper<P> {
//! inner: P,
//! }
//!
//! impl<P> LoggingWrapper<P> {
//! fn new(inner: P) -> Self {
//! Self { inner }
//! }
//! }
//!
//! impl<P, Rin, Win, Ein> Protocol<Rin, Win, Ein> for LoggingWrapper<P>
//! where
//! P: Protocol<Rin, Win, Ein>,
//! Rin: std::fmt::Debug,
//! Win: std::fmt::Debug,
//! {
//! type Rout = P::Rout;
//! type Wout = P::Wout;
//! type Eout = P::Eout;
//! type Error = P::Error;
//! type Time = P::Time; // Inherit time type from wrapped protocol
//!
//! fn handle_read(&mut self, msg: Rin) -> Result<(), Self::Error> {
//! println!("READ: {:?}", msg);
//! self.inner.handle_read(msg)
//! }
//!
//! fn poll_read(&mut self) -> Option<Self::Rout> {
//! self.inner.poll_read()
//! }
//!
//! fn handle_write(&mut self, msg: Win) -> Result<(), Self::Error> {
//! println!("WRITE: {:?}", msg);
//! self.inner.handle_write(msg)
//! }
//!
//! fn poll_write(&mut self) -> Option<Self::Wout> {
//! self.inner.poll_write()
//! }
//! }
//! ```
//!
//! ## Testing Protocols
//!
//! Sans-IO protocols are trivial to test since they don't involve any I/O:
//!
//! ```rust
//! # use sansio::Protocol;
//! # extern crate std;
//! # use std::collections::VecDeque;
//! # #[derive(Debug)]
//! # struct MyError;
//! # impl std::fmt::Display for MyError {
//! # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
//! # write!(f, "MyError")
//! # }
//! # }
//! # impl std::error::Error for MyError {}
//! # struct UppercaseProtocol { routs: VecDeque<String>, wouts: VecDeque<String> }
//! # impl UppercaseProtocol { fn new() -> Self { Self { routs: VecDeque::new(), wouts: VecDeque::new() } } }
//! # impl Protocol<String, String, ()> for UppercaseProtocol {
//! # type Rout = String; type Wout = String; type Eout = (); type Error = MyError; type Time = ();
//! # fn handle_read(&mut self, msg: String) -> Result<(), Self::Error> {
//! # self.routs.push_back(msg.to_uppercase()); Ok(())
//! # }
//! # fn poll_read(&mut self) -> Option<Self::Rout> { self.routs.pop_front() }
//! # fn handle_write(&mut self, msg: String) -> Result<(), Self::Error> {
//! # self.wouts.push_back(msg); Ok(())
//! # }
//! # fn poll_write(&mut self) -> Option<Self::Wout> { self.wouts.pop_front() }
//! # }
//! #[test]
//! fn test_protocol() {
//! let mut protocol = UppercaseProtocol::new();
//!
//! // Test single message
//! protocol.handle_read("hello".to_string()).unwrap();
//! assert_eq!(protocol.poll_read(), Some("HELLO".to_string()));
//!
//! // Test multiple messages
//! protocol.handle_read("foo".to_string()).unwrap();
//! protocol.handle_read("bar".to_string()).unwrap();
//! assert_eq!(protocol.poll_read(), Some("FOO".to_string()));
//! assert_eq!(protocol.poll_read(), Some("BAR".to_string()));
//! assert_eq!(protocol.poll_read(), None);
//! }
//! ```
extern crate alloc;
use Box;
/// A Sans-IO protocol abstraction.
///
/// The `Protocol` trait provides a simplified interface for building network protocols
/// that are fully decoupled from I/O operations.
///
/// # Type Parameters
///
/// - `Rin`: Input read message type
/// - `Win`: Input write message type
/// - `Ein`: Input event type
///
/// # Associated Types
///
/// - `Rout`: Output read message type
/// - `Wout`: Output write message type
/// - `Eout`: Output event type
/// - `Error`: Error type for operations
/// - `Time`: Time/instant type for timeout handling
///
/// # Design Pattern
///
/// This trait follows a push-pull pattern:
/// 1. **Push** data/events into the protocol using `handle_*` methods
/// 2. **Pull** results from the protocol using `poll_*` methods
///
/// This allows the protocol logic to be completely independent of I/O,
/// making it easy to test and reuse in different contexts.
///
/// # Example
///
/// See the [module-level documentation](index.html) for a complete example.
// ========================================
// Blanket Implementations
// ========================================
/// Blanket implementation for mutable references.
///
/// This allows protocols to be used through mutable references without
/// requiring explicit dereferencing.
/// Blanket implementation for boxed protocols.
///
/// This allows protocols to be used through `Box<dyn Protocol>` for dynamic dispatch.