Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Private Function

bufferIndex

Private Function
std.deque.Deque.bufferIndex
fn bufferIndex(deque: *const Self, index: usize) usize

Returns the index in buffer where the element at the given index in the logical deque is stored.

Params

  • deque: *const Self
  • index: usize

File

deque.zig:354
354
355
356
357
358
359
360
361
362
363
        fn bufferIndex(deque: *const Self, index: usize) usize {
            // This function is written in this way to avoid overflow and
            // expensive division.
            const head_len = deque.buffer.len - deque.head;
            if (index < head_len) {
                return deque.head + index;
            } else {
                return index - head_len;
            }
        }