wireman-core 0.1.7

Core for wireman
Documentation
use std::ops::{Deref, DerefMut};

use serde::{ser::SerializeMap, Serialize, Serializer};
use tonic::metadata::{Ascii, KeyRef, MetadataKey, MetadataMap, MetadataValue};

use crate::error::Error;

/// Represents `gRPC` metadata, which contains key-value pairs. Metadata is commonly used to
/// provide additional information with `gRPC` requests and responses.
#[derive(Debug, Clone)]
pub struct Metadata {
    pub(crate) inner: MetadataMap,
}

impl Default for Metadata {
    /// Create a new `Metadata` instance with default values.
    fn default() -> Self {
        Self::new()
    }
}

impl Metadata {
    /// Create a new `Metadata` instance.
    #[must_use]
    pub fn new() -> Self {
        Self {
            inner: MetadataMap::new(),
        }
    }

    /// Insert an ASCII key-value pair into the metadata.
    ///
    /// # Errors
    ///
    /// Returns an error if parsing the key or value to ASCII fails.
    pub fn insert_ascii(&mut self, key: &str, val: &str) -> crate::error::Result<()> {
        let key: MetadataKey<Ascii> = key.parse().map_err(|_| Error::ParseToAsciiError)?;
        let val: MetadataValue<Ascii> = val.parse().map_err(|_| Error::ParseToAsciiError)?;
        self.insert(key, val);
        Ok(())
    }

    /// Serialize the metadata to a format compatible with the given serializer.
    ///
    /// # Errors
    ///
    /// Returns an error if serializing the metadata map fails
    pub fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error> {
        let len = self.inner.len();
        let mut map = ser.serialize_map(Some(len))?;
        for key in self.inner.keys() {
            if let KeyRef::Ascii(ascii_key) = key {
                let Some(value) = self.inner.get(ascii_key) else {
                    continue;
                };
                let key_str = ascii_key.to_string();
                let Ok(value_str) = value.to_str() else {
                    continue;
                };
                map.serialize_entry(&key_str, value_str)?;
            }
        }
        map.end()
    }
}

impl Serialize for Metadata {
    fn serialize<S>(&self, serializer: S) -> core::result::Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let len = self.inner.len();
        let mut map = serializer.serialize_map(Some(len))?;
        for key in self.inner.keys() {
            if let KeyRef::Ascii(ascii_key) = key {
                let value = self.inner.get(ascii_key).unwrap();
                let key_str = ascii_key.to_string();
                let value_str = value.to_str().unwrap();
                map.serialize_entry(&key_str, value_str)?;
            }
        }
        map.end()
    }
}

impl Deref for Metadata {
    type Target = MetadataMap;

    fn deref(&self) -> &Self::Target {
        &self.inner
    }
}

impl DerefMut for Metadata {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.inner
    }
}

#[cfg(test)]
mod test {

    use super::*;

    #[test]
    fn test_serialize() {
        // given
        let mut metadata = Metadata::new();
        metadata.insert_ascii("auth", "bearer").unwrap();
        metadata.insert_ascii("alias", "xx").unwrap();

        let mut s = serde_json::Serializer::new(Vec::new());

        // when
        metadata.serialize(&mut s).unwrap();
        let json = String::from_utf8(s.into_inner()).unwrap();

        // then
        let expected_json = "{\"auth\":\"bearer\",\"alias\":\"xx\"}";
        assert_eq!(json, expected_json);
    }
}