feat(plenary): rename Deque to Dequeue, simplify

Author: clason

lua/neoplen/async/control.lua

@@ -1,5 +1,5 @@
 local a = require "neoplen.async.async"
-local Deque = require("neoplen.async.structs").Deque
+local Dequeue = require "neoplen.async.dequeue"
 
 local M = {}
 
@@ -194,7 +194,7 @@ end
 ---@return table
 ---@return table
 M.channel.mpsc = function()
-  local deque = Deque.new()
+  local deque = Dequeue.new()
   local condvar = Condvar.new()
 
   local Sender = {}

lua/neoplen/async/structs.lua lua/neoplen/async/dequeue.lualua/neoplen/async/structs.lua renamed to lua/neoplen/async/dequeue.lua

@@ -1,37 +1,35 @@
-local M = {}
-
-local Deque = {}
-Deque.__index = Deque
+local Dequeue = {}
+Dequeue.__index = Dequeue
 
 ---@class Deque
 ---A double ended queue
 ---
 ---@return Deque
-function Deque.new()
+function Dequeue.new()
   -- the indexes are created with an offset so that the indices are consequtive
   -- otherwise, when both pushleft and pushright are used, the indices will have a 1 length hole in the middle
-  return setmetatable({ first = 0, last = -1 }, Deque)
+  return setmetatable({ first = 0, last = -1 }, Dequeue)
 end
 
 ---push to the left of the deque
 ---@param value any
-function Deque:pushleft(value)
+function Dequeue:pushleft(value)
   local first = self.first - 1
   self.first = first
   self[first] = value
 end
 
 ---push to the right of the deque
 ---@param value any
-function Deque:pushright(value)
+function Dequeue:pushright(value)
   local last = self.last + 1
   self.last = last
   self[last] = value
 end
 
 ---pop from the left of the deque
 ---@return any
-function Deque:popleft()
+function Dequeue:popleft()
   local first = self.first
   if first > self.last then
     return nil
@@ -44,7 +42,7 @@ end
 
 ---pops from the right of the deque
 ---@return any
-function Deque:popright()
+function Dequeue:popright()
   local last = self.last
   if self.first > last then
     return nil
@@ -57,19 +55,19 @@ end
 
 ---checks if the deque is empty
 ---@return boolean
-function Deque:is_empty()
+function Dequeue:is_empty()
   return self:len() == 0
 end
 
 ---returns the number of elements of the deque
 ---@return number
-function Deque:len()
+function Dequeue:len()
   return self.last - self.first + 1
 end
 
 ---returns and iterator of the indices and values starting from the left
 ---@return function
-function Deque:ipairs_left()
+function Dequeue:ipairs_left()
   local i = self.first
 
   return function()
@@ -86,7 +84,7 @@ end
 
 ---returns and iterator of the indices and values starting from the right
 ---@return function
-function Deque:ipairs_right()
+function Dequeue:ipairs_right()
   local i = self.last
 
   return function()
@@ -103,14 +101,12 @@ end
 
 ---removes all values from the deque
 ---@return nil
-function Deque:clear()
+function Dequeue:clear()
   for i, _ in self:ipairs_left() do
     self[i] = nil
   end
   self.first = 0
   self.last = -1
 end
 
-M.Deque = Deque
-
-return M
+return Dequeue