breese / trial.circular Goto Github PK

Hi,

thanks for this nice project! It was really easy to integrate and use and was the only circular buffer API that fulfilled my needs of being able to bulk resize.

Regarding bulk insertion and removal operations, I was wondering if there would be an option to offer some kind of higher-level API. You offer the segment views, but it is a bit clunky to put in user code and requires some knowledge of the internals of the buffer. I haven't found a better way, but of course it might also be that I just missed it.

For example, to insert a block of data, I currently use:

// add `std::span<std::byte> data` to the end of `circular::span<std::byte> q`
auto copyDestFirstSeg{q.first_unused_segment()};
auto copyDestLastSeg{q.last_unused_segment()};
q.expand_back(data.size());
const auto bytesInFirstSeg{std::min(data.size(), copyDestFirstSeg.size())};
const auto bytesInLastSeg{data.size() - bytesInFirstSeg};
std::copy_n(data.begin(), bytesInFirstSeg, copyDestFirstSeg.begin());
if (bytesInLastSeg > 0) {
	std::copy_n(data.begin() + bytesInFirstSeg, bytesInLastSeg, copyDestLastSeg.begin());
}

Could operations like this be added to the buffer or maybe as a free-standing function? I can imagine it is quite common to want to do this with a circular buffer and I guess it is also the reason you provide the segment queries in the first place.