Replace passed buffer arguments with logical units #610

New Issue

muellerr · 2022-04-29T15:09:59+02:00

muellerr commented

2022-04-29 15:09:59 +02:00

In C or embedded C++ programming, buffers are usually passed like this

int fooWriter(uint8_t* buf, size_t bufLen, uint8_t* writeThis, size_t writeLen) {}
int fooReader(const uint8_t* buf, size_t bufLen) {}

This can become a bit confusing once multiple of these pairs are passed into the function. I think it would be a good idea to pass these parameters as logical pairs:

using BufPair = std::pair<uint8_t*, size_t>;
using ConstBufPair = std::pair<const uint8_t*, size_t>;

int fooWriter(BufPair buf, BufPair toWrite);
int fooReader(ConstBufPair buf);

In C or embedded C++ programming, buffers are usually passed like this ```cpp int fooWriter(uint8_t* buf, size_t bufLen, uint8_t* writeThis, size_t writeLen) {} int fooReader(const uint8_t* buf, size_t bufLen) {} ``` This can become a bit confusing once multiple of these pairs are passed into the function. I think it would be a good idea to pass these parameters as logical pairs: ```cpp using BufPair = std::pair<uint8_t*, size_t>; using ConstBufPair = std::pair<const uint8_t*, size_t>; int fooWriter(BufPair buf, BufPair toWrite); int fooReader(ConstBufPair buf); ```

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: fsfw/fsfw#610