foxglove 0.25.0

Foxglove SDK
Documentation
use std::borrow::Cow;

use bytes::BufMut;

use crate::protocol::{BinaryPayload, ParseError};

/// Pong message sent by the server in response to a
/// [`Ping`](crate::protocol::common::client::Ping).
///
/// The payload contains `[appTimestamp: u64 LE][deviceTimestamp: u64 LE]` (16 bytes),
/// where `appTimestamp` is copied from the first 8 bytes of the ping and
/// `deviceTimestamp` is the server's current time in milliseconds since the Unix epoch.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Pong<'a> {
    /// Pong payload: `[appTimestamp (8 bytes)][deviceTimestamp (8 bytes)]`, both little-endian.
    pub payload: Cow<'a, [u8]>,
}

impl<'a> Pong<'a> {
    #[allow(dead_code)]
    pub fn new(payload: &'a [u8]) -> Self {
        Self {
            payload: Cow::Borrowed(payload),
        }
    }

    pub fn into_owned(self) -> Pong<'static> {
        Pong {
            payload: Cow::Owned(self.payload.into_owned()),
        }
    }
}

impl<'a> BinaryPayload<'a> for Pong<'a> {
    fn parse_payload(data: &'a [u8]) -> Result<Self, ParseError> {
        if data.len() < 16 {
            return Err(ParseError::BufferTooShort);
        }
        Ok(Self {
            payload: Cow::Borrowed(data),
        })
    }

    fn payload_size(&self) -> usize {
        self.payload.len()
    }

    fn write_payload(&self, buf: &mut impl BufMut) {
        buf.put_slice(&self.payload);
    }
}

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

    #[test]
    fn test_roundtrip() {
        let orig = Pong::new(b"1234567890123456");
        let mut buf = Vec::new();
        orig.write_payload(&mut buf);
        let parsed = Pong::parse_payload(&buf).unwrap();
        assert_eq!(parsed, orig);
    }

    #[test]
    fn test_buffer_too_short() {
        let result = Pong::parse_payload(b"short");
        assert!(result.is_err());
    }
}