trait AsyncRedisList[Elem] extends AnyRef
Redis Lists are simply lists of strings, sorted by insertion order. It is possible to add elements to a Redis List pushing new elements on the head (on the left) or on the tail (on the right) of the list.
- Elem
Data type of the inserted element
- Since
2.5.0
- Alphabetic
- By Inheritance
- AsyncRedisList
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def append(element: Elem): CompletionStage[AsyncRedisList[Elem]]
Insert all the specified values at the tail of the list stored at key.
Insert all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation. When key holds a value that is not a list, an error is returned. * It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the tail of the list, from the leftmost element to the rightmost element. So for instance the command RPUSH mylist a b c will result into a list containing a as first element, b as second element and c as third element.
- element
to be apended
- returns
this collection to chain commands
- abstract def apply(index: Int): CompletionStage[Elem]
Returns the element at index index in the list stored at key.
Returns the element at index index in the list stored at key. The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element, -2 means the penultimate and so forth. When the value at key is not a list, an error is returned.
Time complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).
- index
position of the element
- returns
element at the index or exception
- abstract def get(index: Int): CompletionStage[Optional[Elem]]
Returns the element at index index in the list stored at key.
Returns the element at index index in the list stored at key. The index is zero-based, so 0 means the first element, 1 the second element and so on. Negative indices can be used to designate elements starting at the tail of the list. Here, -1 means the last element, -2 means the penultimate and so forth. When the value at key is not a list, an error is returned.
Time complexity: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).
- index
position of the element
- returns
Some(element) at the index, None if no element exists, or exception when the value is not a list
- abstract def headPop(): CompletionStage[Optional[Elem]]
Removes and returns the first element of the list stored at key.
Removes and returns the first element of the list stored at key.
Time complexity: O(1)
- returns
head element if exists
- abstract def insertBefore(pivot: Elem, element: Elem): CompletionStage[Optional[Long]]
Inserts value in the list stored at key either before the reference value pivot.
Inserts value in the list stored at key either before the reference value pivot. When key does not exist, it is considered an empty list and no operation is performed. An error is returned when key exists but does not hold a list value.
Time complexity: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N).
- pivot
insert before this value
- element
elements to be inserted
- returns
new size of the collection or None if pivot not found
- abstract def modify(): AsyncRedisListModification[Elem]
- returns
write-only operations over the collection, modify data
- abstract def prepend(element: Elem): CompletionStage[AsyncRedisList[Elem]]
Insert all the specified values at the head of the list stored at key.
Insert all the specified values at the head of the list stored at key. If key does not exist, it is created as empty list before performing the push operations. When key holds a value that is not a list, an error is returned.
It is possible to push multiple elements using a single command call just specifying multiple arguments at the end of the command. Elements are inserted one after the other to the head of the list, from the leftmost element to the rightmost element. So for instance the command LPUSH mylist a b c will result into a list containing c as first element, b as second element and a as third element.
- element
element to be prepended
- returns
this collection to chain commands
- abstract def remove(element: Elem, count: Int): CompletionStage[AsyncRedisList[Elem]]
Removes first N values equal to the given value from the list.
Removes first N values equal to the given value from the list.
Note: If the value is serialized object, it is not proofed that serialized strings will match and the value will be actually deleted. This function is intended to be used with primitive types only.
Time complexity: O(N)
- element
element to be removed from the list
- count
first N occurrences
- returns
this collection to chain commands
- abstract def remove(element: Elem): CompletionStage[AsyncRedisList[Elem]]
Removes first value equal to the given value from the list.
Removes first value equal to the given value from the list.
Note: If the value is serialized object, it is not proofed that serialized strings will match and the value will be actually deleted. This function is intended to be used with primitive types only.
Time complexity: O(N)
- element
element to be removed from the list
- returns
this collection to chain commands
- abstract def removeAt(position: Int): CompletionStage[AsyncRedisList[Elem]]
Removes the element at the given position.
Removes the element at the given position. If the index is out of range, it throws an exception.
Time complexity: O(N)
- position
element index to be removed
- returns
this collection to chain commands
- abstract def set(position: Int, element: Elem): CompletionStage[AsyncRedisList[Elem]]
Sets the list element at index to value.
Sets the list element at index to value. For more information on the index argument, see LINDEX. An error is returned for out of range indexes.
- position
position to insert at
- element
elements to be inserted
- returns
this collection to chain commands
- abstract def view(): AsyncRedisListView[Elem]
- returns
read-only operations over the collection, does not modify data
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def head(): CompletionStage[Elem]
- returns
first element of the collection or an exception
- def headOption(): CompletionStage[Optional[Elem]]
- returns
first element of the collection or None
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def last(): CompletionStage[Elem]
- returns
last element of the collection or an exception
- def lastOption(): CompletionStage[Optional[Elem]]
- returns
last element of the collection or None
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toList(): CompletionStage[List[Elem]]
- returns
Helper to this.view.all returning all object in the list
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()