mmkv 0.7.0

Rust version of MMKV
Documentation
use crate::core::buffer::{Buffer, DecodeResult};
use crate::core::memory_map::MemoryMap;
use std::collections::HashMap;

const LOG_TAG: &str = "MMKV:MemoryMap";

pub struct Iter<'a, F>
where
    F: Fn(&[u8], u32) -> crate::Result<DecodeResult>,
{
    mm: &'a MemoryMap,
    pub position: u32,
    start: usize,
    end: usize,
    decode: F,
}

impl MemoryMap {
    pub fn iter<F>(&self, decode: F) -> Iter<'_, F>
    where
        F: Fn(&[u8], u32) -> crate::Result<DecodeResult>,
    {
        let start = self.content_start_offset();
        let end = self.write_offset();
        Iter {
            mm: self,
            position: 0,
            start,
            end,
            decode,
        }
    }
}

impl<F> Iter<'_, F>
where
    F: Fn(&[u8], u32) -> crate::Result<DecodeResult>,
{
    pub fn into_map(self) -> (HashMap<String, Buffer>, u32) {
        let mut iter_count = 0;
        let mut map = HashMap::new();
        self.for_each(|buffer| {
            iter_count += 1;
            if let Some(data) = buffer {
                if data.is_deleting() {
                    map.remove(data.key());
                } else {
                    map.insert(data.key().to_string(), data);
                }
            }
        });
        (map, iter_count)
    }
}

impl<F> Iterator for Iter<'_, F>
where
    F: Fn(&[u8], u32) -> crate::Result<DecodeResult>,
{
    type Item = Option<Buffer>;

    fn next(&mut self) -> Option<Self::Item> {
        if self.start >= self.end {
            return None;
        }
        let bytes = self.mm.read(self.start..self.end);
        let decode_result = (self.decode)(bytes, self.position);
        self.position += 1;
        match decode_result {
            Ok(result) => {
                self.start += result.len as usize;
                Some(result.buffer)
            }
            Err(e) => {
                error!(LOG_TAG, "Failed to iter memory map, reason: {:?}", e);
                None
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use std::fs;
    use std::fs::OpenOptions;
    use std::mem::size_of;

    use crate::Error::DataInvalid;
    use crate::Result;
    use crate::core::buffer::{Buffer, DecodeResult, Decoder, Encoder};
    use crate::core::memory_map::MemoryMap;

    const LOG_TAG: &str = "MMKV:IterTest";

    struct TestEncoderDecoder;
    impl Encoder for TestEncoderDecoder {
        fn encode_to_bytes(&self, raw_buffer: &Buffer, _: u32) -> Result<Vec<u8>> {
            let bytes_to_write = raw_buffer.to_bytes();
            let len = bytes_to_write.len() as u32;
            let mut data = len.to_be_bytes().to_vec();
            data.extend_from_slice(bytes_to_write.as_slice());
            Ok(data)
        }
    }

    impl Decoder for TestEncoderDecoder {
        fn decode_bytes(&self, data: &[u8], _: u32) -> Result<DecodeResult> {
            let offset = size_of::<u32>();
            let item_len = u32::from_be_bytes(data[0..offset].try_into().map_err(|_| DataInvalid)?);
            let bytes_to_decode = &data[offset..(offset + item_len as usize)];
            let read_len = offset as u32 + item_len;
            let result = Buffer::from_encoded_bytes(bytes_to_decode);
            let buffer = match result {
                Ok(data) => Some(data),
                Err(e) => {
                    error!(LOG_TAG, "Failed to decode data, reason: {:?}", e);
                    None
                }
            };
            Ok(DecodeResult {
                buffer,
                len: read_len,
            })
        }
    }

    #[test]
    fn test_mmap_iterator() {
        let file_name = "test_mmap_iterator";
        let _ = fs::remove_file(file_name);
        let file = OpenOptions::new()
            .create(true)
            .truncate(true)
            .write(true)
            .read(true)
            .open(file_name)
            .unwrap();
        file.set_len(1024).unwrap();
        let mut mm = MemoryMap::new(&file, 1024).unwrap();
        let mut buffers: Vec<Buffer> = vec![];
        let test_encoder = &TestEncoderDecoder;
        for i in 0..10 {
            let buffer = Buffer::new(&i.to_string(), i);
            mm.append(&test_encoder.encode_to_bytes(&buffer, i as u32).unwrap())
                .unwrap();
            buffers.push(buffer);
        }
        let decoder = &TestEncoderDecoder;
        for (index, i) in mm
            .iter(|bytes, position| decoder.decode_bytes(bytes, position))
            .enumerate()
        {
            assert_eq!(buffers[index], i.unwrap());
        }
        let _ = fs::remove_file("test_mmap_iterator");
    }
}