Add @discardableResult to commands that are not readonly (#140)

Author: adam-fowler

Sources/Valkey/Commands/BitmapCommands.swift

@@ -492,6 +492,7 @@ extension ValkeyConnectionProtocol {
     ///     * [Array]: The result of the subcommand at the same position
     ///     * [Array]: In case OVERFLOW FAIL was given and overflows or underflows detected
     @inlinable
+    @discardableResult
     public func bitfield(_ key: ValkeyKey, operations: [BITFIELD.Operation] = []) async throws -> RESPToken.Array {
         try await send(command: BITFIELD(key, operations: operations))
     }
@@ -514,6 +515,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N)
     /// - Response: [Integer]: The size of the string stored in the destination key, that is equal to the size of the longest input string.
     @inlinable
+    @discardableResult
     public func bitop(operation: BITOP.Operation, destkey: ValkeyKey, keys: [ValkeyKey]) async throws -> Int {
         try await send(command: BITOP(operation: operation, destkey: destkey, keys: keys))
     }
@@ -551,6 +553,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: The original bit value stored at offset.
     @inlinable
+    @discardableResult
     public func setbit(_ key: ValkeyKey, offset: Int, value: Int) async throws -> Int {
         try await send(command: SETBIT(key, offset: offset, value: value))
     }

Sources/Valkey/Commands/ClusterCommands.swift

@@ -687,6 +687,7 @@ extension ValkeyConnectionProtocol {
     ///     * [String]: If the epoch was incremented.
     ///     * [String]: If the node already has the greatest config epoch in the cluster.
     @inlinable
+    @discardableResult
     public func clusterBumpepoch() async throws -> ByteBuffer {
         try await send(command: CLUSTER.BUMPEPOCH())
     }
@@ -698,6 +699,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of failure reports
     /// - Response: [Integer]: The number of active failure reports for the node.
     @inlinable
+    @discardableResult
     public func clusterCountFailureReports<NodeId: RESPStringRenderable>(nodeId: NodeId) async throws -> Int {
         try await send(command: CLUSTER.COUNTFAILUREREPORTS(nodeId: nodeId))
     }
@@ -709,6 +711,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Integer]: The number of keys in the specified hash slot.
     @inlinable
+    @discardableResult
     public func clusterCountkeysinslot(slot: Int) async throws -> Int {
         try await send(command: CLUSTER.COUNTKEYSINSLOT(slot: slot))
     }
@@ -770,6 +773,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of requested keys
     /// - Response: [Array]: An array with up to count elements.
     @inlinable
+    @discardableResult
     public func clusterGetkeysinslot(slot: Int, count: Int) async throws -> RESPToken.Array {
         try await send(command: CLUSTER.GETKEYSINSLOT(slot: slot, count: count))
     }
@@ -781,6 +785,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Array]: Helpful text about subcommands.
     @inlinable
+    @discardableResult
     public func clusterHelp() async throws -> RESPToken.Array {
         try await send(command: CLUSTER.HELP())
     }
@@ -792,6 +797,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [String]: A map between named fields and values in the form of <field>:<value> lines separated by newlines composed by the two bytes CRLF
     @inlinable
+    @discardableResult
     public func clusterInfo() async throws -> ByteBuffer {
         try await send(command: CLUSTER.INFO())
     }
@@ -803,6 +809,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of bytes in the key
     /// - Response: [Integer]: The hash slot number for the specified key
     @inlinable
+    @discardableResult
     public func clusterKeyslot<Key: RESPStringRenderable>(_ key: Key) async throws -> Int {
         try await send(command: CLUSTER.KEYSLOT(key))
     }
@@ -814,6 +821,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the total number of Cluster nodes
     /// - Response: [Array]: An array of cluster links and their attributes.
     @inlinable
+    @discardableResult
     public func clusterLinks() async throws -> RESPToken.Array {
         try await send(command: CLUSTER.LINKS())
     }
@@ -837,6 +845,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [String]: The node id.
     @inlinable
+    @discardableResult
     public func clusterMyid() async throws -> ByteBuffer {
         try await send(command: CLUSTER.MYID())
     }
@@ -848,6 +857,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [String]: The node's shard id.
     @inlinable
+    @discardableResult
     public func clusterMyshardid() async throws -> ByteBuffer {
         try await send(command: CLUSTER.MYSHARDID())
     }
@@ -859,6 +869,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the total number of Cluster nodes
     /// - Response: [String]: The serialized cluster configuration.
     @inlinable
+    @discardableResult
     public func clusterNodes() async throws -> ByteBuffer {
         try await send(command: CLUSTER.NODES())
     }
@@ -870,6 +881,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of replicas.
     /// - Response: [Array]: A list of replica nodes replicating from the specified primary node provided in the same format used by CLUSTER NODES.
     @inlinable
+    @discardableResult
     public func clusterReplicas<NodeId: RESPStringRenderable>(nodeId: NodeId) async throws -> RESPToken.Array {
         try await send(command: CLUSTER.REPLICAS(nodeId: nodeId))
     }
@@ -933,6 +945,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the total number of cluster nodes
     /// - Response: [Array]: A nested list of a map of hash ranges and shard nodes describing individual shards.
     @inlinable
+    @discardableResult
     public func clusterShards() async throws -> CLUSTER.SHARDS.Response {
         try await send(command: CLUSTER.SHARDS())
     }
@@ -945,6 +958,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of replicas.
     /// - Response: [Array]: A list of replica nodes replicating from the specified primary node provided in the same format used by CLUSTER NODES.
     @inlinable
+    @discardableResult
     public func clusterSlaves<NodeId: RESPStringRenderable>(nodeId: NodeId) async throws -> RESPToken.Array {
         try await send(command: CLUSTER.SLAVES(nodeId: nodeId))
     }
@@ -956,6 +970,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the total number of slots based on arguments. O(N*log(N)) with ORDERBY subcommand.
     /// - Response: [Array]: Array of nested arrays, where the inner array element represents a slot and its respective usage statistics.
     @inlinable
+    @discardableResult
     public func clusterSlotStats(filter: CLUSTER.SLOTSTATS.Filter) async throws -> RESPToken.Array {
         try await send(command: CLUSTER.SLOTSTATS(filter: filter))
     }
@@ -970,6 +985,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the total number of Cluster nodes
     /// - Response: [Array]: Nested list of slot ranges with networking information.
     @inlinable
+    @discardableResult
     public func clusterSlots() async throws -> RESPToken.Array {
         try await send(command: CLUSTER.SLOTS())
     }

Sources/Valkey/Commands/ConnectionCommands.swift

@@ -808,6 +808,7 @@ extension ValkeyConnectionProtocol {
     /// - Available: 2.4.0
     /// - Complexity: Depends on subcommand.
     @inlinable
+    @discardableResult
     public func client() async throws -> CLIENT.Response {
         try await send(command: CLIENT())
     }
@@ -841,6 +842,7 @@ extension ValkeyConnectionProtocol {
     ///     * [String]: The connection name of the current connection
     ///     * [Null]: Connection name was not set
     @inlinable
+    @discardableResult
     public func clientGetname() async throws -> ByteBuffer? {
         try await send(command: CLIENT.GETNAME())
     }
@@ -855,6 +857,7 @@ extension ValkeyConnectionProtocol {
     ///     * -1: Client tracking is not enabled.
     ///     * [Integer]: ID of the client we are redirecting the notifications to.
     @inlinable
+    @discardableResult
     public func clientGetredir() async throws -> Int {
         try await send(command: CLIENT.GETREDIR())
     }
@@ -866,6 +869,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Array]: Helpful text about subcommands.
     @inlinable
+    @discardableResult
     public func clientHelp() async throws -> RESPToken.Array {
         try await send(command: CLIENT.HELP())
     }
@@ -877,6 +881,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Integer]: The id of the client
     @inlinable
+    @discardableResult
     public func clientId() async throws -> Int {
         try await send(command: CLIENT.ID())
     }
@@ -898,6 +903,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [String]: A unique string, as described at the CLIENT LIST page, for the current client.
     @inlinable
+    @discardableResult
     public func clientInfo() async throws -> ByteBuffer {
         try await send(command: CLIENT.INFO())
     }
@@ -920,6 +926,7 @@ extension ValkeyConnectionProtocol {
     ///     * "OK": When called in 3 argument format.
     ///     * [Integer]: When called in filter/value format, the number of clients killed.
     @inlinable
+    @discardableResult
     public func clientKill(filter: CLIENT.KILL.Filter) async throws -> Int? {
         try await send(command: CLIENT.KILL(filter: filter))
     }
@@ -940,6 +947,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of client connections
     /// - Response: [String]: Information and statistics about client connections
     @inlinable
+    @discardableResult
     public func clientList(
         clientType: CLIENT.LIST.ClientType? = nil,
         clientIds: [Int] = [],
@@ -1052,6 +1060,7 @@ extension ValkeyConnectionProtocol {
     /// - Available: 6.2.0
     /// - Complexity: O(1)
     @inlinable
+    @discardableResult
     public func clientTrackinginfo() async throws -> RESPToken.Map {
         try await send(command: CLIENT.TRACKINGINFO())
     }
@@ -1065,6 +1074,7 @@ extension ValkeyConnectionProtocol {
     ///     * 0: If the client was unblocked successfully.
     ///     * 1: If the client wasn't unblocked.
     @inlinable
+    @discardableResult
     public func clientUnblock(clientId: Int, unblockType: CLIENT.UNBLOCK.UnblockType? = nil) async throws -> Int {
         try await send(command: CLIENT.UNBLOCK(clientId: clientId, unblockType: unblockType))
     }
@@ -1086,6 +1096,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [String]: The given string
     @inlinable
+    @discardableResult
     public func echo<Message: RESPStringRenderable>(message: Message) async throws -> ByteBuffer {
         try await send(command: ECHO(message: message))
     }
@@ -1099,6 +1110,7 @@ extension ValkeyConnectionProtocol {
     ///     * 6.2.0: `protover` made optional; when called without arguments the command reports the current connection's context.
     /// - Complexity: O(1)
     @inlinable
+    @discardableResult
     public func hello(arguments: HELLO.Arguments? = nil) async throws -> RESPToken.Map {
         try await send(command: HELLO(arguments: arguments))
     }
@@ -1112,6 +1124,7 @@ extension ValkeyConnectionProtocol {
     ///     * "PONG": Default reply.
     ///     * [String]: Relay of given `message`.
     @inlinable
+    @discardableResult
     public func ping(message: String? = nil) async throws -> PING.Response {
         try await send(command: PING(message: message))
     }
@@ -1133,6 +1146,7 @@ extension ValkeyConnectionProtocol {
     /// - Available: 6.2.0
     /// - Complexity: O(1)
     @inlinable
+    @discardableResult
     public func reset() async throws -> String {
         try await send(command: RESET())
     }

Sources/Valkey/Commands/GenericCommands.swift

@@ -1009,6 +1009,7 @@ extension ValkeyConnectionProtocol {
     ///     * 1: Source was copied.
     ///     * 0: Source was not copied when the destination key already exists
     @inlinable
+    @discardableResult
     public func copy(source: ValkeyKey, destination: ValkeyKey, destinationDb: Int? = nil, replace: Bool = false) async throws -> Int {
         try await send(command: COPY(source: source, destination: destination, destinationDb: destinationDb, replace: replace))
     }
@@ -1020,6 +1021,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).
     /// - Response: [Integer]: The number of keys that were removed.
     @inlinable
+    @discardableResult
     public func del(keys: [ValkeyKey]) async throws -> Int {
         try await send(command: DEL(keys: keys))
     }
@@ -1061,6 +1063,7 @@ extension ValkeyConnectionProtocol {
     ///     * 0: The timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
     ///     * 1: The timeout was set.
     @inlinable
+    @discardableResult
     public func expire(_ key: ValkeyKey, seconds: Int, condition: EXPIRE.Condition? = nil) async throws -> Int {
         try await send(command: EXPIRE(key, seconds: seconds, condition: condition))
     }
@@ -1076,6 +1079,7 @@ extension ValkeyConnectionProtocol {
     ///     * 1: The timeout was set.
     ///     * 0: The timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
     @inlinable
+    @discardableResult
     public func expireat(_ key: ValkeyKey, unixTimeSeconds: Date, condition: EXPIREAT.Condition? = nil) async throws -> Int {
         try await send(command: EXPIREAT(key, unixTimeSeconds: unixTimeSeconds, condition: condition))
     }
@@ -1119,6 +1123,7 @@ extension ValkeyConnectionProtocol {
     ///     * "OK": Success.
     ///     * "NOKEY": No keys were found in the source instance.
     @inlinable
+    @discardableResult
     public func migrate<Host: RESPStringRenderable>(
         host: Host,
         port: Int,
@@ -1154,6 +1159,7 @@ extension ValkeyConnectionProtocol {
     ///     * 1: Key was moved.
     ///     * 0: Key wasn't moved. When key already exists in the destination database, or it does not exist in the source database
     @inlinable
+    @discardableResult
     public func move(_ key: ValkeyKey, db: Int) async throws -> Int {
         try await send(command: MOVE(key, db: db))
     }
@@ -1189,6 +1195,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Array]: Helpful text about subcommands.
     @inlinable
+    @discardableResult
     public func objectHelp() async throws -> RESPToken.Array {
         try await send(command: OBJECT.HELP())
     }
@@ -1224,6 +1231,7 @@ extension ValkeyConnectionProtocol {
     ///     * 0: Key does not exist or does not have an associated timeout.
     ///     * 1: The timeout has been removed.
     @inlinable
+    @discardableResult
     public func persist(_ key: ValkeyKey) async throws -> Int {
         try await send(command: PERSIST(key))
     }
@@ -1239,6 +1247,7 @@ extension ValkeyConnectionProtocol {
     ///     * 0: The timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
     ///     * 1: The timeout was set.
     @inlinable
+    @discardableResult
     public func pexpire(_ key: ValkeyKey, milliseconds: Int, condition: PEXPIRE.Condition? = nil) async throws -> Int {
         try await send(command: PEXPIRE(key, milliseconds: milliseconds, condition: condition))
     }
@@ -1254,6 +1263,7 @@ extension ValkeyConnectionProtocol {
     ///     * 1: The timeout was set.
     ///     * 0: The timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
     @inlinable
+    @discardableResult
     public func pexpireat(_ key: ValkeyKey, unixTimeMilliseconds: Date, condition: PEXPIREAT.Condition? = nil) async throws -> Int {
         try await send(command: PEXPIREAT(key, unixTimeMilliseconds: unixTimeMilliseconds, condition: condition))
     }
@@ -1322,6 +1332,7 @@ extension ValkeyConnectionProtocol {
     ///     * 1: Key was renamed to newkey.
     ///     * 0: New key already exists.
     @inlinable
+    @discardableResult
     public func renamenx(_ key: ValkeyKey, newkey: ValkeyKey) async throws -> Int {
         try await send(command: RENAMENX(key, newkey: newkey))
     }
@@ -1380,6 +1391,7 @@ extension ValkeyConnectionProtocol {
     ///     * [Integer]: When the store option is specified the command returns the number of sorted elements in the destination list.
     ///     * [Array]: When not passing the store option the command returns a list of sorted elements.
     @inlinable
+    @discardableResult
     public func sort(
         _ key: ValkeyKey,
         byPattern: String? = nil,
@@ -1459,6 +1471,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of.
     /// - Response: [Integer]: The number of keys that were unlinked.
     @inlinable
+    @discardableResult
     public func unlink(keys: [ValkeyKey]) async throws -> Int {
         try await send(command: UNLINK(keys: keys))
     }
@@ -1470,6 +1483,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Integer]: The number of replicas reached by all the writes performed in the context of the current connection.
     @inlinable
+    @discardableResult
     public func wait(numreplicas: Int, timeout: Int) async throws -> Int {
         try await send(command: WAIT(numreplicas: numreplicas, timeout: timeout))
     }
@@ -1481,6 +1495,7 @@ extension ValkeyConnectionProtocol {
     /// - Complexity: O(1)
     /// - Response: [Array]: Number of local and remote AOF files in sync.
     @inlinable
+    @discardableResult
     public func waitaof(numlocal: Int, numreplicas: Int, timeout: Int) async throws -> RESPToken.Array {
         try await send(command: WAITAOF(numlocal: numlocal, numreplicas: numreplicas, timeout: timeout))
     }