Rename Buffer[View] to SerialBuffer[View]

SpaceTeam · Sep 15, 2024 · 999d3b8 · 999d3b8
1 parent 3d66ead
commit 999d3b8
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 14 deletions.
diff --git a/Sts1CobcSw/Edu/Edu.cpp b/Sts1CobcSw/Edu/Edu.cpp
@@ -432,7 +432,7 @@ auto ReceiveDataPacket() -> Result<void>
 template<typename T>
 auto Receive() -> Result<T>
 {
-    auto buffer = Buffer<T>{};
+    auto buffer = SerialBuffer<T>{};
     OUTCOME_TRY(Receive(buffer));
     return Deserialize<T>(buffer);
 }

diff --git a/Sts1CobcSw/Periphery/Eps.cpp b/Sts1CobcSw/Periphery/Eps.cpp
@@ -230,7 +230,7 @@ auto ReadAdc(hal::GpioPin * adcCsPin) -> AdcValues
     RODOS::AT(RODOS::NOW() + conversionTime);
 
     // Resolution is 12 bit, sent like this: [0 0 0 0 MSB x x x], [x x x x x x x LSB]
-    auto adcData = Buffer<AdcValues>{};
+    auto adcData = SerialBuffer<AdcValues>{};
     adcCsPin->Reset();
     hal::ReadFrom(&framEpsSpi, Span(&adcData), spiTimeout);
     adcCsPin->Set();

diff --git a/Sts1CobcSw/Serial/Serial.hpp b/Sts1CobcSw/Serial/Serial.hpp
@@ -59,25 +59,24 @@ inline constexpr auto defaultEndianness = std::endian::little;
 
 template<typename T>
     requires(serialSize<T> != 0)
-using Buffer = std::array<Byte, serialSize<T>>;
+using SerialBuffer = std::array<Byte, serialSize<T>>;
 
-// TODO: Maybe remove this type alias or prepend "Serial" to both again
 template<typename T>
     requires(serialSize<T> != 0)
-using BufferView = std::span<Byte const, serialSize<T>>;
+using SerialBufferView = std::span<Byte const, serialSize<T>>;
 
 
 template<typename T>
-[[nodiscard]] auto Serialize(T const & t) -> Buffer<T>;
+[[nodiscard]] auto Serialize(T const & t) -> SerialBuffer<T>;
 
 template<std::endian endianness, typename T>
-[[nodiscard]] auto Serialize(T const & t) -> Buffer<T>;
+[[nodiscard]] auto Serialize(T const & t) -> SerialBuffer<T>;
 
 template<std::default_initializable T>
-[[nodiscard]] auto Deserialize(BufferView<T> bufferView) -> T;
+[[nodiscard]] auto Deserialize(SerialBufferView<T> bufferView) -> T;
 
 template<std::endian endianness, std::default_initializable T>
-[[nodiscard]] auto Deserialize(BufferView<T> bufferView) -> T;
+[[nodiscard]] auto Deserialize(SerialBufferView<T> bufferView) -> T;
 
 // Must be overloaded for user-defined types to be serializable
 template<std::endian endianness, TriviallySerializable T>

diff --git a/Sts1CobcSw/Serial/Serial.ipp b/Sts1CobcSw/Serial/Serial.ipp
@@ -7,30 +7,30 @@
 namespace sts1cobcsw
 {
 template<typename T>
-inline auto Serialize(T const & t) -> Buffer<T>
+inline auto Serialize(T const & t) -> SerialBuffer<T>
 {
     return Serialize<defaultEndianness>(t);
 }
 
 
 template<std::endian endianness, typename T>
-inline auto Serialize(T const & t) -> Buffer<T>
+inline auto Serialize(T const & t) -> SerialBuffer<T>
 {
-    auto buffer = Buffer<T>{};
+    auto buffer = SerialBuffer<T>{};
     (void)SerializeTo<endianness>(buffer.data(), t);
     return buffer;
 }
 
 
 template<std::default_initializable T>
-inline auto Deserialize(BufferView<T> bufferView) -> T
+inline auto Deserialize(SerialBufferView<T> bufferView) -> T
 {
     return Deserialize<defaultEndianness, T>(bufferView);
 }
 
 
 template<std::endian endianness, std::default_initializable T>
-inline auto Deserialize(BufferView<T> bufferView) -> T
+inline auto Deserialize(SerialBufferView<T> bufferView) -> T
 {
     auto t = T{};
     (void)DeserializeFrom<endianness>(bufferView.data(), &t);