// BytesQueue is a non-thread safe queue type of fifo based on bytes array.
// BytesQueue 是基于字節(jié)數(shù)組的非線程安全隊(duì)列類型的FIFO。
// For every push operation index of entry is returned. It can be used to read the entry later
// 對(duì)于每個(gè)推送操作索引，都會(huì)返回。它可用于稍后閱讀條目。
type BytesQueue struct {
    full         bool
    array        []byte // 真正存儲(chǔ)數(shù)據(jù)的地方
    capacity     int    // array 的容量
    maxCapacity  int    // array 可申請(qǐng)的最大容量
    head         int
    tail         int // 下次可以插入 item 的位置
    count        int // 當(dāng)前插入的 item 數(shù)量
    rightMargin  int
    headerBuffer []byte // 插入前做臨時(shí) buffer 所用（slice-copy）
    verbose      bool   // 打印 log 開(kāi)關(guān)
}

func NewBytesQueue(capacity int, maxCapacity int, verbose bool) *BytesQueue {
    return &BytesQueue{
        array:        make([]byte, capacity), // 真正存儲(chǔ)數(shù)據(jù)的地方，長(zhǎng)度為capacity，直接初始化每個(gè)值
        capacity:     capacity,
        maxCapacity:  maxCapacity,
        headerBuffer: make([]byte, binary.MaxVarintLen32),
        tail:         leftMarginIndex,
        head:         leftMarginIndex,
        rightMargin:  leftMarginIndex,
        verbose:      verbose,
    }
}

func TestQueuePush(t *testing.T) {
    // 初始化一個(gè)byte隊(duì)列
    queue := NewBytesQueue(5, 0, false)
    t.Log(queue) // &{false [0 0 0 0 0] 5 0 1 1 0 1 [0 0 0 0 0] false}
    // 調(diào)用Push方法，會(huì)返回獲取這個(gè)值的index索引
    index, err := queue.Push([]byte("a"))
    t.Log(index, err) // 1 <nil>
    index, err = queue.Push([]byte("b"))
    t.Log(index, err) // 3 <nil>
    // 通過(guò)index索引就可以獲取到這個(gè)值
    a, err2 := queue.Get(1)
    t.Log(string(a), err2) // a <nil>
    b, err2 := queue.Get(3)
    t.Log(string(b), err2) // b <nil>
}

func (q *BytesQueue) Push(data []byte) (int, error) {
    neededSize := getNeededSize(len(data))
    ....... // 省略
    index := q.tail

    q.push(data, neededSize)

    return index, nil
}

func (q *BytesQueue) push(data []byte, len int) {
    headerEntrySize := binary.PutUvarint(q.headerBuffer, uint64(len))
    q.copy(q.headerBuffer, headerEntrySize) // 用一個(gè)8字節(jié)保存data的長(zhǎng)度
    q.copy(data, len-headerEntrySize)       // 寫(xiě)入data
    if q.tail > q.head {
        q.rightMargin = q.tail
    }
    if q.tail == q.head {
        q.full = true
    }
    q.count++
}