Ringbuff #3
Ringbuff #3
Conversation
| @@ -86,3 +86,171 @@ const MXCErrors = enum(c_int) { | |||
| E_NOT_SUPPORTED = -17, | |||
| E_FAIL = -255, | |||
| }; | |||
|
|
|||
| pub fn RingBuffer(comptime T: type, comptime capacity: usize) type { | |||
There was a problem hiding this comment.
Move the RingBuffer into its own file
| pub fn peek(self: *Self) !T { | ||
| if (self.isEmpty()) { | ||
| return error.BufferEmpty; | ||
| } | ||
|
|
||
| return self.buffer[self.head]; | ||
| } |
There was a problem hiding this comment.
I don't think peek should return an error. A ?T feels more natural to me
| @@ -86,3 +86,171 @@ const MXCErrors = enum(c_int) { | |||
| E_NOT_SUPPORTED = -17, | |||
| E_FAIL = -255, | |||
| }; | |||
|
|
|||
| pub fn RingBuffer(comptime T: type, comptime capacity: usize) type { | |||
There was a problem hiding this comment.
Not sure if comptime capacity: usize or comptime_int is more idiomatic zig, but I guess this is fine if it works
| head: usize = 0, | ||
| tail: usize = 0, | ||
| count: usize = 0, |
There was a problem hiding this comment.
Fun fact: you can use std.math.IntFittingRange(comptime from: comptime_int, comptime to: comptime_int) which "Returns the smallest integer type that can hold both from and to."
This optimization is definitely unnecessary in this case but it is cool :)
| return error.BufferFull; | ||
| } | ||
|
|
||
| self.buffer[self.tail] = item; |
There was a problem hiding this comment.
To me the head is what advances and is what you push to...not the tail. Layer 4's ring buffer at least uses the convention that the head is in front
| test "ring buf underflow" { | ||
| var rb = RingBuffer(u8, 3).init(); | ||
|
|
||
| try std.testing.expectError(error.BufferEmpty, rb.pop()); | ||
| try std.testing.expectError(error.BufferEmpty, rb.peek()); | ||
| } |
|
|
||
| pub fn init() Self { | ||
| return Self{ | ||
| .buffer = undefined, |
There was a problem hiding this comment.
buffer can be initialized as a default value along with the others in this struct
mbund
force-pushed
the
main
branch
2 times, most recently
from
025eed6 to
776a82f
Compare
|
This is for an old version |
Generic ring buffer with peek and tests.