nym/common/socks5/ordered-buffer/src/sender.rs

use crate::message::OrderedMessage;

/// Assigns sequence numbers to outbound byte vectors. These messages can then
/// be reassembled into an ordered sequence by the `OrderedMessageSender`.
#[derive(Debug)]
pub struct OrderedMessageSender {
    next_index: u64,
}

impl OrderedMessageSender {
    pub fn new() -> OrderedMessageSender {
        OrderedMessageSender { next_index: 0 }
    }

    /// Turns raw bytes into an OrderedMessage containing the original bytes
    /// and a sequence number;
    pub fn wrap_message(&mut self, input: Vec<u8>) -> OrderedMessage {
        let message = OrderedMessage {
            data: input.to_vec(),
            index: self.next_index,
        };
        self.next_index += 1;
        message
    }
}

#[cfg(test)]
mod ordered_message_sender {
    use super::*;

    mod when_input_bytes_are_empty {}

    #[cfg(test)]
    mod sequence_index_numbers {
        use super::*;

        #[test]
        fn increase_as_messages_are_sent() {
            let mut sender = OrderedMessageSender::new();
            let first_bytes = vec![1, 2, 3, 4];
            let second_bytes = vec![5, 6, 7, 8];

            let first_message = sender.wrap_message(first_bytes);

            assert_eq!(first_message.index, 0);

            let second_message = sender.wrap_message(second_bytes);
            assert_eq!(second_message.index, 1);
        }
    }
}