falco_event/types/
bytebuf.rs

use crate::fields::{FromBytes, FromBytesResult, ToBytes};
use crate::types::format::{format_type, Format};
use crate::types::{Borrow, BorrowDeref, Borrowed};
use std::fmt::{Formatter, Write as _};
use std::io::Write;

impl<'a> FromBytes<'a> for &'a [u8] {
    fn from_bytes(buf: &mut &'a [u8]) -> FromBytesResult<Self> {
        Ok(std::mem::take(buf))
    }
}

impl ToBytes for &[u8] {
    fn binary_size(&self) -> usize {
        self.len()
    }

    fn write<W: Write>(&self, mut writer: W) -> std::io::Result<()> {
        writer.write_all(self)
    }

    fn default_repr() -> impl ToBytes {
        &[] as &[u8]
    }
}

impl Format<format_type::PF_NA> for &[u8] {
    fn format(&self, fmt: &mut Formatter) -> std::fmt::Result {
        for c in *self {
            let c = *c;
            if !(b' '..=0x7e).contains(&c) {
                fmt.write_char('.')?;
            } else {
                fmt.write_char(c as char)?;
            }
        }

        Ok(())
    }
}

impl Format<format_type::PF_DEC> for &[u8] {
    fn format(&self, fmt: &mut Formatter) -> std::fmt::Result {
        // this is actually the same as PF_NA
        <Self as Format<format_type::PF_NA>>::format(self, fmt)
    }
}

impl Format<format_type::PF_HEX> for &[u8] {
    fn format(&self, fmt: &mut Formatter) -> std::fmt::Result {
        let mut first = true;
        for c in *self {
            if first {
                first = false;
            } else {
                write!(fmt, " ")?;
            }
            write!(fmt, "{:02x}", *c)?;
        }

        Ok(())
    }
}

impl Borrowed for [u8] {
    type Owned = Vec<u8>;
}

impl Borrow for Vec<u8> {
    type Borrowed<'a> = &'a [u8];

    fn borrow(&self) -> Self::Borrowed<'_> {
        self.as_slice()
    }
}

impl BorrowDeref for Vec<u8> {
    type Target<'c>
        = &'c [u8]
    where
        Self: 'c;

    fn borrow_deref(&self) -> Self::Target<'_> {
        self.as_slice()
    }
}

#[cfg(feature = "serde")]
pub mod serde {
    pub mod bytebuf {
        use crate::types::utf_chunked::{OwnedUtfChunked, UtfChunked};
        use serde::{Deserialize, Deserializer, Serialize, Serializer};

        pub fn serialize<S: Serializer>(buf: &[u8], ser: S) -> Result<S::Ok, S::Error> {
            if ser.is_human_readable() {
                let chunks = UtfChunked::from(buf);
                chunks.serialize(ser)
            } else {
                buf.serialize(ser)
            }
        }

        pub fn deserialize<'de, D: Deserializer<'de>>(de: D) -> Result<Vec<u8>, D::Error> {
            let chunks: OwnedUtfChunked = Deserialize::deserialize(de)?;
            Ok(chunks.into_vec())
        }
    }

    pub mod bytebuf_option {
        use crate::types::utf_chunked::UtfChunked;
        use serde::{Serialize, Serializer};

        pub fn serialize<S: Serializer>(buf: &Option<&[u8]>, ser: S) -> Result<S::Ok, S::Error> {
            if ser.is_human_readable() {
                let chunks = buf.as_ref().map(|buf| UtfChunked::from(*buf));
                chunks.serialize(ser)
            } else {
                buf.serialize(ser)
            }
        }
    }

    pub mod bytebuf_option_owned {
        use crate::types::utf_chunked::{OwnedUtfChunked, UtfChunked};
        use serde::{Deserialize, Deserializer, Serialize, Serializer};

        pub fn serialize<S: Serializer>(buf: &Option<Vec<u8>>, ser: S) -> Result<S::Ok, S::Error> {
            let chunks = buf.as_ref().map(|buf| UtfChunked::from(buf.as_slice()));
            chunks.serialize(ser)
        }

        pub fn deserialize<'de, D: Deserializer<'de>>(de: D) -> Result<Option<Vec<u8>>, D::Error> {
            let chunks: Option<OwnedUtfChunked> = Deserialize::deserialize(de)?;
            Ok(chunks.map(OwnedUtfChunked::into_vec))
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::event_derive::{FromBytes, ToBytes};

    #[test]
    fn test_bytebuf() {
        let data = b"foo".as_slice();
        let mut binary = Vec::new();

        data.write(&mut binary).unwrap();
        hexdump::hexdump(binary.as_slice());

        assert_eq!(binary.as_slice(), "foo".as_bytes());

        let mut buf = binary.as_slice();
        let loaded = <&[u8]>::from_bytes(&mut buf).unwrap();
        assert_eq!(loaded, "foo".as_bytes());
    }

    #[test]
    fn test_bytebuf_inner_nul() {
        let data = b"f\0oo".as_slice();
        let mut binary = Vec::new();

        data.write(&mut binary).unwrap();
        hexdump::hexdump(binary.as_slice());

        assert_eq!(binary.as_slice(), "f\0oo".as_bytes());

        let mut buf = binary.as_slice();
        let loaded = <&[u8]>::from_bytes(&mut buf).unwrap();
        assert_eq!(loaded, "f\0oo".as_bytes());
    }
}
falco_event/types/bytebuf.rs

falco_event/types/
bytebuf.rs
