bp3d_proto/codec/arrays.rs
1// Copyright (c) 2024, BlockProject 3D
2//
3// All rights reserved.
4//
5// Redistribution and use in source and binary forms, with or without modification,
6// are permitted provided that the following conditions are met:
7//
8// * Redistributions of source code must retain the above copyright notice,
9// this list of conditions and the following disclaimer.
10// * Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13// * Neither the name of BlockProject 3D nor the names of its contributors
14// may be used to endorse or promote products derived from this software
15// without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29use crate::codec::ByteCodec;
30use bytesutil::{ReadBytes, WriteBytes};
31use std::marker::PhantomData;
32
33pub struct ArrayCodec<B, Item, C, const ITEM_BIT_SIZE: usize> {
34 buffer: B,
35 useless: PhantomData<Item>,
36 useless1: PhantomData<C>,
37}
38
39impl<B, Item, C, const ITEM_BIT_SIZE: usize> ArrayCodec<B, Item, C, ITEM_BIT_SIZE> {
40 pub fn new(buffer: B) -> Self {
41 Self {
42 buffer,
43 useless: PhantomData,
44 useless1: PhantomData,
45 }
46 }
47}
48
49impl<B: AsRef<[u8]>, Item: ReadBytes, C: ByteCodec, const ITEM_BIT_SIZE: usize> ArrayCodec<B, Item, C, ITEM_BIT_SIZE> {
50 pub fn get(&self, index: usize) -> Item {
51 let byte_size = ITEM_BIT_SIZE / 8;
52 let pos = index * byte_size;
53 let end = pos + byte_size;
54 C::read::<Item>(&self.buffer.as_ref()[pos..end])
55 }
56
57 pub fn len(&self) -> usize {
58 let byte_size = ITEM_BIT_SIZE / 8;
59 self.buffer.as_ref().len() / byte_size
60 }
61
62 pub fn is_empty(&self) -> bool {
63 self.len() == 0
64 }
65
66 pub fn iter_raw(&self) -> impl Iterator<Item = Item> + '_ {
67 let byte_size = ITEM_BIT_SIZE / 8;
68 self.buffer.as_ref().chunks(byte_size).map(|v| C::read::<Item>(v))
69 }
70}
71
72impl<B: AsMut<[u8]>, Item: WriteBytes, C: ByteCodec, const ITEM_BIT_SIZE: usize> ArrayCodec<B, Item, C, ITEM_BIT_SIZE> {
73 pub fn set(&mut self, index: usize, value: Item) -> &mut Self {
74 let byte_size = ITEM_BIT_SIZE / 8;
75 let pos = index * byte_size;
76 let end = pos + byte_size;
77 C::write::<Item>(&mut self.buffer.as_mut()[pos..end], value);
78 self
79 }
80}
81
82impl<B: AsMut<[u8]>, C> AsMut<[u8]> for ArrayCodec<B, u8, C, 8> {
83 fn as_mut(&mut self) -> &mut [u8] {
84 self.buffer.as_mut()
85 }
86}
87
88impl<B: AsRef<[u8]>, C> AsRef<[u8]> for ArrayCodec<B, u8, C, 8> {
89 fn as_ref(&self) -> &[u8] {
90 self.buffer.as_ref()
91 }
92}