Module: Redis::Commands::Lists
- Included in:
- Redis::Commands
- Defined in:
- lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb
Instance Method Summary collapse
-
#blmove(source, destination, where_source, where_destination, timeout: 0) ⇒ nil, String
Remove the first/last element in a list and append/prepend it to another list and return it, or block until one is available.
-
#blpop(*args) ⇒ nil, [String, String]
Remove and get the first element in a list, or block until one is available.
-
#brpop(*args) ⇒ nil, [String, String]
Remove and get the last element in a list, or block until one is available.
-
#brpoplpush(source, destination, timeout: 0) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
-
#lindex(key, index) ⇒ String
Get an element from a list by its index.
-
#linsert(key, where, pivot, value) ⇒ Integer
Insert an element before or after another element in a list.
-
#llen(key) ⇒ Integer
Get the length of a list.
-
#lmove(source, destination, where_source, where_destination) ⇒ nil, String
Remove the first/last element in a list, append/prepend it to another list and return it.
-
#lpop(key, count = nil) ⇒ nil, ...
Remove and get the first elements in a list.
-
#lpush(key, value) ⇒ Integer
Prepend one or more values to a list, creating the list if it doesn’t exist.
-
#lpushx(key, value) ⇒ Integer
Prepend a value to a list, only if the list exists.
-
#lrange(key, start, stop) ⇒ Array<String>
Get a range of elements from a list.
-
#lrem(key, count, value) ⇒ Integer
Remove elements from a list.
-
#lset(key, index, value) ⇒ String
Set the value of an element in a list by its index.
-
#ltrim(key, start, stop) ⇒ String
Trim a list to the specified range.
-
#rpop(key, count = nil) ⇒ nil, ...
Remove and get the last elements in a list.
-
#rpoplpush(source, destination) ⇒ nil, String
Remove the last element in a list, append it to another list and return it.
-
#rpush(key, value) ⇒ Integer
Append one or more values to a list, creating the list if it doesn’t exist.
-
#rpushx(key, value) ⇒ Integer
Append a value to a list, only if the list exists.
Instance Method Details
#blmove(source, destination, where_source, where_destination, timeout: 0) ⇒ nil, String
Remove the first/last element in a list and append/prepend it to another list and return it, or block until one is available.
55 56 57 58 59 60 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 55 def blmove(source, destination, where_source, where_destination, timeout: 0) where_source, where_destination = _normalize_move_wheres(where_source, where_destination) command = [:blmove, source, destination, where_source, where_destination, timeout] send_blocking_command(command, timeout) end |
#blpop(*args) ⇒ nil, [String, String]
Remove and get the first element in a list, or block until one is available.
150 151 152 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 150 def blpop(*args) _bpop(:blpop, args) end |
#brpop(*args) ⇒ nil, [String, String]
Remove and get the last element in a list, or block until one is available.
166 167 168 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 166 def brpop(*args) _bpop(:brpop, args) end |
#brpoplpush(source, destination, timeout: 0) ⇒ nil, String
Pop a value from a list, push it to another list and return it; or block until one is available.
181 182 183 184 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 181 def brpoplpush(source, destination, timeout: 0) command = [:brpoplpush, source, destination, timeout] send_blocking_command(command, timeout) end |
#lindex(key, index) ⇒ String
Get an element from a list by its index.
191 192 193 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 191 def lindex(key, index) send_command([:lindex, key, Integer(index)]) end |
#linsert(key, where, pivot, value) ⇒ Integer
Insert an element before or after another element in a list.
203 204 205 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 203 def linsert(key, where, pivot, value) send_command([:linsert, key, where, pivot, value]) end |
#llen(key) ⇒ Integer
Get the length of a list.
10 11 12 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 10 def llen(key) send_command([:llen, key]) end |
#lmove(source, destination, where_source, where_destination) ⇒ nil, String
This command comes in place of the now deprecated RPOPLPUSH. Doing LMOVE RIGHT LEFT is equivalent.
Remove the first/last element in a list, append/prepend it to another list and return it.
27 28 29 30 31 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 27 def lmove(source, destination, where_source, where_destination) where_source, where_destination = _normalize_move_wheres(where_source, where_destination) send_command([:lmove, source, destination, where_source, where_destination]) end |
#lpop(key, count = nil) ⇒ nil, ...
Remove and get the first elements in a list.
103 104 105 106 107 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 103 def lpop(key, count = nil) command = [:lpop, key] command << Integer(count) if count send_command(command) end |
#lpush(key, value) ⇒ Integer
Prepend one or more values to a list, creating the list if it doesn’t exist
67 68 69 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 67 def lpush(key, value) send_command([:lpush, key, value]) end |
#lpushx(key, value) ⇒ Integer
Prepend a value to a list, only if the list exists.
76 77 78 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 76 def lpushx(key, value) send_command([:lpushx, key, value]) end |
#lrange(key, start, stop) ⇒ Array<String>
Get a range of elements from a list.
213 214 215 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 213 def lrange(key, start, stop) send_command([:lrange, key, Integer(start), Integer(stop)]) end |
#lrem(key, count, value) ⇒ Integer
Remove elements from a list.
226 227 228 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 226 def lrem(key, count, value) send_command([:lrem, key, Integer(count), value]) end |
#lset(key, index, value) ⇒ String
Set the value of an element in a list by its index.
236 237 238 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 236 def lset(key, index, value) send_command([:lset, key, Integer(index), value]) end |
#ltrim(key, start, stop) ⇒ String
Trim a list to the specified range.
246 247 248 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 246 def ltrim(key, start, stop) send_command([:ltrim, key, Integer(start), Integer(stop)]) end |
#rpop(key, count = nil) ⇒ nil, ...
Remove and get the last elements in a list.
114 115 116 117 118 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 114 def rpop(key, count = nil) command = [:rpop, key] command << Integer(count) if count send_command(command) end |
#rpoplpush(source, destination) ⇒ nil, String
Remove the last element in a list, append it to another list and return it.
125 126 127 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 125 def rpoplpush(source, destination) send_command([:rpoplpush, source, destination]) end |
#rpush(key, value) ⇒ Integer
Append one or more values to a list, creating the list if it doesn’t exist
85 86 87 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 85 def rpush(key, value) send_command([:rpush, key, value]) end |
#rpushx(key, value) ⇒ Integer
Append a value to a list, only if the list exists.
94 95 96 |
# File 'lib/rubypitaya/app-template/vendor/bundle/ruby/3.1.0/gems/redis-5.0.5/lib/redis/commands/lists.rb', line 94 def rpushx(key, value) send_command([:rpushx, key, value]) end |