pkg/SugarDB
1
0
Fork 0
mirror of https://github.com/EchoVault/SugarDB.git synced 2025-10-05 16:06:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added godoc comments for api_list.go functions

Browse Source
This commit is contained in:
Kelvin Mwinuka
2024-04-03 04:41:41 +08:00
parent 4055432891
commit 4fbabbdc56
4 changed files with 1004 additions and 836 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1644
coverage/coverage.out
View File

File diff suppressed because it is too large Load Diff

181
pkg/echovault/api_list.go
View File

@@ -20,6 +20,17 @@ import (
"strconv"
)
// LLEN returns the length of the list.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// Returns: The length of the list as an integer. Returns 0 if the key does not exist.
//
// Errors:
//
// "LLEN command on non-list item" - when the provided key exists but is not a list.
func (server *EchoVault) LLEN(key string) (int, error) {
b, err := server.handleCommand(server.context, internal.EncodeCommand([]string{"LLEN", key}), nil, false)
fmt.Println(key, string(b), err)
@@ -29,6 +40,26 @@ func (server *EchoVault) LLEN(key string) (int, error) {
return internal.ParseIntegerResponse(b)
}
// LRANGE returns the elements within the index range provided.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `start` - int - the start index. If start index is less than end index, the returned sub-list will be reversed.
//
// `end` - int - the end index. When -1 is passed for end index, the function will return the list from start
// index to the end of the list.
//
// Returns: A string slice containing the elements within the given indices.
//
// Errors:
//
// "LRANGE command on non-list item" - when the provided key exists but is not a list.
//
// "start index must be within list boundary" - when the start index is not within the list boundaries.
//
// "end index must be within list range or -1" - when end index is not within the list boundaries.
func (server *EchoVault) LRANGE(key string, start, end int) ([]string, error) {
b, err := server.handleCommand(
server.context,
@@ -42,15 +73,47 @@ func (server *EchoVault) LRANGE(key string, start, end int) ([]string, error) {
return internal.ParseStringArrayResponse(b)
}
func (server *EchoVault) LINDEX(key string, index int) (string, error) {
// LINDEX retrieves the element at the provided index from the list without removing it.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `index` - int - the index to retrieve from.
//
// Returns: The element at the given index as a string.
//
// Errors:
//
// "LINDEX command on non-list item" - when the provided key exists but is not a list.
//
// "index must be within list range" - when the index is not within the list boundary.
func (server *EchoVault) LINDEX(key string, index uint) (string, error) {
b, err := server.handleCommand(
server.context, internal.EncodeCommand([]string{"LINDEX", key, strconv.Itoa(index)}), nil, false)
server.context, internal.EncodeCommand([]string{"LINDEX", key, strconv.Itoa(int(index))}), nil, false)
if err != nil {
return "", err
}
return internal.ParseStringResponse(b)
}
// LSET updates the value at the given index of a list.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `index` - int - the index to retrieve from.
//
// `value` - string - the new value to place at the given index.
//
// Returns: "OK" if the update is successful.
//
// Errors:
//
// "LSET command on non-list item" - when the provided key exists but is not a list.
//
// "index must be within list range" - when the index is not within the list boundary.
func (server *EchoVault) LSET(key string, index int, value string) (string, error) {
b, err := server.handleCommand(
server.context, internal.EncodeCommand([]string{"LSET", key, strconv.Itoa(index), value}), nil, false)
@@ -60,6 +123,8 @@ func (server *EchoVault) LSET(key string, index int, value string) (string, erro
return internal.ParseStringResponse(b)
}
// LTRIM work similarly to LRANGE but instead of returning the new list, it replaces the original list with the
// trimmed list.
func (server *EchoVault) LTRIM(key string, start int, end int) (string, error) {
b, err := server.handleCommand(
server.context, internal.EncodeCommand([]string{"LTRIM", key, strconv.Itoa(start), strconv.Itoa(end)}),
@@ -72,6 +137,21 @@ func (server *EchoVault) LTRIM(key string, start int, end int) (string, error) {
return internal.ParseStringResponse(b)
}
// LREM removes 'count' instances of the specified element from the list.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `count` - int - the number of instances of the element to remove.
//
// `value` - string - the element to remove.
//
// Returns: "OK" if the removal was successful.
//
// Errors:
//
// "LREM command on non-list item" - when the provided key exists but is not a list.
func (server *EchoVault) LREM(key string, count int, value string) (string, error) {
b, err := server.handleCommand(
server.context, internal.EncodeCommand([]string{"LREM", key, strconv.Itoa(count), value}),
@@ -84,6 +164,27 @@ func (server *EchoVault) LREM(key string, count int, value string) (string, erro
return internal.ParseStringResponse(b)
}
// LMOVE moves an element from one list to another.
//
// Parameters:
//
// `source` - string - the key to the source list.
//
// `destination` - string - the key to the destination list.
//
// `whereFrom` - string - either "LEFT" or "RIGHT". If "LEFT", the element is removed from the beginning of the source list.
// If "RIGHT", the element is removed from the end of the source list.
//
// `whereTo` - string - either "LEFT" or "RIGHT". If "LEFT", the element is added to the beginning of the destination list.
// If "RIGHT", the element is added to the end of the destination list.
//
// Returns: "OK" if the removal was successful.
//
// Errors:
//
// "both source and destination must be lists" - when either source or destination are not lists.
//
// "wherefrom and whereto arguments must be either LEFT or RIGHT" - if whereFrom or whereTo are not either "LEFT" or "RIGHT".
func (server *EchoVault) LMOVE(source, destination, whereFrom, whereTo string) (string, error) {
b, err := server.handleCommand(
server.context, internal.EncodeCommand([]string{"LMOVE", source, destination, whereFrom, whereTo}),
@@ -96,6 +197,17 @@ func (server *EchoVault) LMOVE(source, destination, whereFrom, whereTo string) (
return internal.ParseStringResponse(b)
}
// LPOP pops an element from the start of the list and return it.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// Returns: The popped element as a string.
//
// Errors:
//
// "LPOP command on non-list item" - when the provided key is not a list.
func (server *EchoVault) LPOP(key string) (string, error) {
b, err := server.handleCommand(server.context, internal.EncodeCommand([]string{"LPOP", key}), nil, false)
if err != nil {
@@ -104,6 +216,17 @@ func (server *EchoVault) LPOP(key string) (string, error) {
return internal.ParseStringResponse(b)
}
// RPOP pops an element from the end of the list and return it.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// Returns: The popped element as a string.
//
// Errors:
//
// "RPOP command on non-list item" - when the provided key is not a list.
func (server *EchoVault) RPOP(key string) (string, error) {
b, err := server.handleCommand(server.context, internal.EncodeCommand([]string{"RPOP", key}), nil, false)
if err != nil {
@@ -112,6 +235,20 @@ func (server *EchoVault) RPOP(key string) (string, error) {
return internal.ParseStringResponse(b)
}
// LPUSH pushed 1 or more values to the beginning of a list. If the list does not exist, a new list is created
// wth the passed elements as its members.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `values` - ...string - the list of elements to add to push to the beginning of the list.
//
// Returns: "OK" when the list has been successfully modified or created.
//
// Errors:
//
// "LPUSH command on non-list item" - when the provided key is not a list.
func (server *EchoVault) LPUSH(key string, values ...string) (string, error) {
cmd := append([]string{"LPUSH", key}, values...)
b, err := server.handleCommand(server.context, internal.EncodeCommand(cmd), nil, false)
@@ -121,6 +258,19 @@ func (server *EchoVault) LPUSH(key string, values ...string) (string, error) {
return internal.ParseStringResponse(b)
}
// LPUSHX pushed 1 or more values to the beginning of an existing list. The command only succeeds on a pre-existing list.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `values` - ...string - the list of elements to add to push to the beginning of the list.
//
// Returns: "OK" when the list has been successfully modified.
//
// Errors:
//
// "LPUSHX command on non-list item" - when the provided key is not a list or doesn't exist.
func (server *EchoVault) LPUSHX(key string, values ...string) (string, error) {
cmd := append([]string{"LPUSHX", key}, values...)
b, err := server.handleCommand(server.context, internal.EncodeCommand(cmd), nil, false)
@@ -130,6 +280,20 @@ func (server *EchoVault) LPUSHX(key string, values ...string) (string, error) {
return internal.ParseStringResponse(b)
}
// RPUSH pushed 1 or more values to the end of a list. If the list does not exist, a new list is created
// wth the passed elements as its members.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `values` - ...string - the list of elements to add to push to the end of the list.
//
// Returns: "OK" when the list has been successfully modified or created.
//
// Errors:
//
// "RPUSH command on non-list item" - when the provided key is not a list.
func (server *EchoVault) RPUSH(key string, values ...string) (string, error) {
cmd := append([]string{"RPUSH", key}, values...)
b, err := server.handleCommand(server.context, internal.EncodeCommand(cmd), nil, false)
@@ -139,6 +303,19 @@ func (server *EchoVault) RPUSH(key string, values ...string) (string, error) {
return internal.ParseStringResponse(b)
}
// RPUSHX pushed 1 or more values to the end of an existing list. The command only succeeds on a pre-existing list.
//
// Parameters:
//
// `key` - string - the key to the list.
//
// `values` - ...string - the list of elements to add to push to the end of the list.
//
// Returns: "OK" when the list has been successfully modified.
//
// Errors:
//
// "RPUSHX command on non-list item" - when the provided key is not a list or doesn't exist.
func (server *EchoVault) RPUSHX(key string, values ...string) (string, error) {
cmd := append([]string{"RPUSHX", key}, values...)
b, err := server.handleCommand(server.context, internal.EncodeCommand(cmd), nil, false)

11
pkg/echovault/api_list_test.go
View File

@@ -94,7 +94,7 @@ func TestEchoVault_LINDEX(t *testing.T) {
preset bool
presetValue interface{}
key string
index int
index uint
name string
want string
wantErr bool
@@ -153,15 +153,6 @@ func TestEchoVault_LINDEX(t *testing.T) {
want: "",
wantErr: true,
},
{
name: "Trying to get index out of range with negative index",
preset: true,
presetValue: []interface{}{"value1", "value2", "value3"},
key: "key7",
index: -1,
want: "",
wantErr: true,
},
}
for _, tt := range tests {
if tt.preset {

4
pkg/modules/list/commands.go
View File

@@ -382,7 +382,7 @@ func handleLMove(ctx context.Context, cmd []string, server types.EchoVault, conn
return []byte(constants.OkResponse), nil
}
func handleLPush(ctx context.Context, cmd []string, server types.EchoVault, conn *net.Conn) ([]byte, error) {
func handleLPush(ctx context.Context, cmd []string, server types.EchoVault, _ *net.Conn) ([]byte, error) {
keys, err := lpushKeyFunc(cmd)
if err != nil {
return nil, err
@@ -581,7 +581,7 @@ func Commands() []types.Command {
Command: "ltrim",
Module: constants.ListModule,
Categories: []string{constants.ListCategory, constants.WriteCategory, constants.SlowCategory},
Description: "(LTRIM key start end) Trims a list to the specified range.",
Description: "(LTRIM key start end) Trims a list using the specified range.",
Sync: true,
KeyExtractionFunc: ltrimKeyFunc,
HandlerFunc: handleLTrim,