Module
Module documentation.
modulenet.redis
Classes
Classes and inheritance.
classnet.redis::Message
@brief`Message` type.
@details`Message` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Message {
/*
@brief `kind` field.classnet.redis::ResultList
@brief`ResultList` type.
@details`ResultList` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ResultList {
/*
@brief `values` field.classnet.redis::Conn
@brief`Conn` type.
@details`Conn` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Conn {
/*
@brief `fd` field.classnet.redis::Pipeline
@brief`Pipeline` type.
@details`Pipeline` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Pipeline {
/*
@brief `conn` field.classnet.redis::Subscriber
@brief`Subscriber` type.
@details`Subscriber` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Subscriber {
/*
@brief `conn` field.classnet.redis::Pool
@brief`Pool` type.
@details`Pool` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class Pool {
/*
@brief `cfg` field.classnet.redis::SlotRange
@brief`SlotRange` type.
@details`SlotRange` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class SlotRange {
/*
@brief `start_slot` field.classnet.redis::ClusterClient
@brief`ClusterClient` type.
@details`ClusterClient` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class ClusterClient {
/*
@brief `cfg` field.classnet.redis::SentinelConfig
@brief`SentinelConfig` type.
@details`SentinelConfig` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class SentinelConfig {
/*
@brief `sentinels` field.classnet.redis::SentinelClient
@brief`SentinelClient` type.
@details`SentinelClient` encapsulates state and operations exported by the system module. It commonly stores runtime handles, protocol state, buffers, configuration, or collection data. Its methods define the primary behavior for the type. If the type owns external resources, prefer `dispose` or `close` for deterministic release.
class SentinelClient {
/*
@brief `cfg` field.Functions
Free functions and class methods.
functionnet.redis::Message.init
Signature
func init(self: net.redis.Message) -> Void func init(self: net.redis.Message) -> Void {
self.kind = "";
self.channel = "";@briefInitializes a `Message` instance.
@detailsEstablishes the initial field state for `Message` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Message.deinit
Signature
func deinit(self: net.redis.Message) -> Void func deinit(self: net.redis.Message) -> Void {
}
}@briefReleases fallback resources at the end of the `Message` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::ResultList.init
Signature
func init(self: net.redis.ResultList) -> Void func init(self: net.redis.ResultList) -> Void {
self.values = new collections.Vector<protocol.redis.RespValue>();
}@briefInitializes a `ResultList` instance.
@detailsEstablishes the initial field state for `ResultList` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::ResultList.len
Signature
func len(self: net.redis.ResultList) -> Int func len(self: net.redis.ResultList) -> Int {
return self.values.len();
}@briefReturns the element count or byte length with `ResultList.len`.
@detailsExecutes the `len` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionnet.redis::ResultList.get
Signature
func get(self: net.redis.ResultList, idx: Int) -> protocol.redis.RespValue func get(self: net.redis.ResultList, idx: Int) -> protocol.redis.RespValue {
return self.values.get_unchecked(idx);
}@briefReads the element for `ResultList.get`.
@detailsExecutes the `get` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- idxZero-based index.
@returnReturns the operation result as `protocol.redis.RespValue`.
functionnet.redis::ResultList.push
Signature
func push(self: net.redis.ResultList, value: protocol.redis.RespValue) -> Void func push(self: net.redis.ResultList, value: protocol.redis.RespValue) -> Void {
_ = self.values.push(value);
}@briefAppends an element with `ResultList.push`.
@detailsExecutes the `push` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- valueValue to write or store.
@returnVoid
functionnet.redis::ResultList.append_from_resp
Signature
func append_from_resp(self: net.redis.ResultList, value: protocol.redis.RespValue) -> ErrCode func append_from_resp(self: net.redis.ResultList, value: protocol.redis.RespValue) -> ErrCode {
if value.kind != protocol.redis.RESP_ARRAY && value.kind != protocol.redis.RESP_SET && value.kind != protocol.redis.RESP_PUSH {
return std.ERR_INVALID;@briefProvides the system library operation `ResultList.append_from_resp`.
@detailsExecutes the `append_from_resp` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::ResultList.deinit
Signature
func deinit(self: net.redis.ResultList) -> Void func deinit(self: net.redis.ResultList) -> Void {
}
}@briefReleases fallback resources at the end of the `ResultList` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Conn.init
Signature
func init(self: net.redis.Conn, fd: Int, timeout_ms: Int = 5000) -> Void func init(self: net.redis.Conn, fd: Int, timeout_ms: Int = 5000) -> Void {
self.fd = fd;
self.tls_h = 0;@briefInitializes a `Conn` instance.
@detailsEstablishes the initial field state for `Conn` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- fdOperating-system file descriptor or socket descriptor.
- timeout_msTimeout in milliseconds; negative values usually select blocking or default timeout behavior.
@returnVoid
functionnet.redis::Conn.set_timeouts
Signature
func set_timeouts(self: net.redis.Conn, read_timeout_ms: Int, write_timeout_ms: Int) -> Void func set_timeouts(self: net.redis.Conn, read_timeout_ms: Int, write_timeout_ms: Int) -> Void {
self.read_timeout_ms = read_timeout_ms;
self.write_timeout_ms = write_timeout_ms;@briefSets state or configuration with `Conn.set_timeouts`.
@detailsExecutes the `set_timeouts` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- read_timeout_msTime interval or timeout value in milliseconds.
- write_timeout_msTime interval or timeout value in milliseconds.
@returnVoid
functionnet.redis::Conn.mark_broken
Signature
func mark_broken(self: net.redis.Conn, err: protocol.redis.RedisError) -> Void func mark_broken(self: net.redis.Conn, err: protocol.redis.RedisError) -> Void {
self.broken = true;
self.last_error = err;@briefProvides the system library operation `Conn.mark_broken`.
@detailsExecutes the `mark_broken` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- errError code or error object.
@returnVoid
functionnet.redis::Conn.clear_error
Signature
func clear_error(self: net.redis.Conn) -> Void func clear_error(self: net.redis.Conn) -> Void {
self.last_error = new protocol.redis.RedisError();
}@briefProvides the system library operation `Conn.clear_error`.
@detailsExecutes the `clear_error` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Conn.recv_some
Signature
func recv_some(self: net.redis.Conn, max_bytes: Int) -> String, ErrCode func recv_some(self: net.redis.Conn, max_bytes: Int) -> String, ErrCode {
if self.closed || self.broken {
return "", std.ERR_INVALID;@briefProvides the system library operation `Conn.recv_some`.
@detailsExecutes the `recv_some` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- max_bytesMaximum number of bytes to read or process in this operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.send_some
Signature
func send_some(self: net.redis.Conn, data: String) -> Int, ErrCode func send_some(self: net.redis.Conn, data: String) -> Int, ErrCode {
if self.closed || self.broken {
return 0, std.ERR_INVALID;@briefProvides the system library operation `Conn.send_some`.
@detailsExecutes the `send_some` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- dataInput or output data buffer.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.send_all
Signature
func send_all(self: net.redis.Conn, data: String) -> ErrCode func send_all(self: net.redis.Conn, data: String) -> ErrCode {
let off: Int = 0;
loop (; off < std.len(data); ) {@briefProvides the system library operation `Conn.send_all`.
@detailsExecutes the `send_all` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- dataInput or output data buffer.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.read_value
Signature
func read_value(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func read_value(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
loop (; true; ) {
let value, parsed_err = self.reader.next();@briefReads data with `Conn.read_value`.
@detailsExecutes the `read_value` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.command
Signature
func command(self: net.redis.Conn, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func command(self: net.redis.Conn, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
if self.in_pubsub {
return new protocol.redis.RespValue(), std.ERR_INVALID;@briefProvides the system library operation `Conn.command`.
@detailsExecutes the `command` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- argsArgument list forwarded to the command, process, callback, or formatter.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.command_raw
Signature
func command_raw(self: net.redis.Conn, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func command_raw(self: net.redis.Conn, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
_ = self.clear_error();
let wire: String = protocol.redis.encode_command(args);@briefProvides the system library operation `Conn.command_raw`.
@detailsExecutes the `command_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- argsArgument list forwarded to the command, process, callback, or formatter.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.ping
Signature
func ping(self: net.redis.Conn) -> ErrCode func ping(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("PING"));
if err != std.OK {@briefProvides the system library operation `Conn.ping`.
@detailsExecutes the `ping` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hello
Signature
func hello(self: net.redis.Conn, version: Int) -> protocol.redis.RespValue, ErrCode func hello(self: net.redis.Conn, version: Int) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("HELLO", strconv.itoa(version)));
}@briefProvides the system library operation `Conn.hello`.
@detailsExecutes the `hello` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- versionProtocol, API, or data-format version selected by the operation.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.auth
Signature
func auth(self: net.redis.Conn, password: String) -> ErrCode func auth(self: net.redis.Conn, password: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("AUTH", password));
if err != std.OK {@briefProvides the system library operation `Conn.auth`.
@detailsExecutes the `auth` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- passwordPassword or authentication secret supplied to the protocol login flow.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.auth_user
Signature
func auth_user(self: net.redis.Conn, username: String, password: String) -> ErrCode func auth_user(self: net.redis.Conn, username: String, password: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("AUTH", username, password));
if err != std.OK {@briefProvides the system library operation `Conn.auth_user`.
@detailsExecutes the `auth_user` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- usernameUser name supplied for authentication or account lookup.
- passwordPassword or authentication secret supplied to the protocol login flow.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.select
Signature
func select(self: net.redis.Conn, database: Int) -> ErrCode func select(self: net.redis.Conn, database: Int) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("SELECT", strconv.itoa(database)));
if err != std.OK {@briefProvides the system library operation `Conn.select`.
@detailsExecutes the `select` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- databaseDatabase name or database index selected for the connection or command.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.client_setname
Signature
func client_setname(self: net.redis.Conn, name: String) -> ErrCode func client_setname(self: net.redis.Conn, name: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("CLIENT", "SETNAME", name));
if err != std.OK {@briefProvides the system library operation `Conn.client_setname`.
@detailsExecutes the `client_setname` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- nameName.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.client_tracking
Signature
func client_tracking(self: net.redis.Conn, mode: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func client_tracking(self: net.redis.Conn, mode: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("CLIENT");@briefProvides the system library operation `Conn.client_tracking`.
@detailsExecutes the `client_tracking` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- modeMode value that selects permissions, behavior, or formatting rules for the operation.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.get
Signature
func get(self: net.redis.Conn, key: String) -> String, ErrCode func get(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GET", key))?;
if v.is_null() {@briefReads the element for `Conn.get`.
@detailsExecutes the `get` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.set
Signature
func set(self: net.redis.Conn, key: String, value: String) -> ErrCode func set(self: net.redis.Conn, key: String, value: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("SET", key, value));
if err != std.OK {@briefSets an element with `Conn.set`.
@detailsExecutes the `set` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.getex
Signature
func getex(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> String, ErrCode func getex(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("GETEX", key, options))?;
if v.is_null() {@briefProvides the system library operation `Conn.getex`.
@detailsExecutes the `getex` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.mget
Signature
func mget(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode func mget(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("MGET", keys))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.mget`.
@detailsExecutes the `mget` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.mset
Signature
func mset(self: net.redis.Conn, key_values: collections.Vector<String>) -> ErrCode func mset(self: net.redis.Conn, key_values: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_values("MSET", key_values));
if err != std.OK {@briefProvides the system library operation `Conn.mset`.
@detailsExecutes the `mset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- key_valuesFlat collection of alternating keys and values.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.incr
Signature
func incr(self: net.redis.Conn, key: String) -> Int, ErrCode func incr(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("INCR", key))?;
return v.as_int();@briefProvides the system library operation `Conn.incr`.
@detailsExecutes the `incr` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.decr
Signature
func decr(self: net.redis.Conn, key: String) -> Int, ErrCode func decr(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DECR", key))?;
return v.as_int();@briefProvides the system library operation `Conn.decr`.
@detailsExecutes the `decr` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.set_ex
Signature
func set_ex(self: net.redis.Conn, key: String, value: String, ttl_sec: Int) -> ErrCode func set_ex(self: net.redis.Conn, key: String, value: String, ttl_sec: Int) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("SET", key, value, "EX", strconv.itoa(ttl_sec)));
if err != std.OK {@briefSets state or configuration with `Conn.set_ex`.
@detailsExecutes the `set_ex` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
- ttl_secTime-to-live duration in seconds before the stored value or protocol entry expires.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.del
Signature
func del(self: net.redis.Conn, key: String) -> Int, ErrCode func del(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DEL", key))?;
return v.as_int();@briefProvides the system library operation `Conn.del`.
@detailsExecutes the `del` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.del_many
Signature
func del_many(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode func del_many(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("DEL", keys))?;
return v.as_int();@briefProvides the system library operation `Conn.del_many`.
@detailsExecutes the `del_many` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.exists
Signature
func exists(self: net.redis.Conn, key: String) -> Bool, ErrCode func exists(self: net.redis.Conn, key: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("EXISTS", key))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.exists`.
@detailsExecutes the `exists` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.exists_many
Signature
func exists_many(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode func exists_many(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("EXISTS", keys))?;
return v.as_int();@briefProvides the system library operation `Conn.exists_many`.
@detailsExecutes the `exists_many` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.expire
Signature
func expire(self: net.redis.Conn, key: String, ttl_sec: Int) -> Bool, ErrCode func expire(self: net.redis.Conn, key: String, ttl_sec: Int) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("EXPIRE", key, strconv.itoa(ttl_sec)))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.expire`.
@detailsExecutes the `expire` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- ttl_secTime-to-live duration in seconds before the stored value or protocol entry expires.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.ttl
Signature
func ttl(self: net.redis.Conn, key: String) -> Int, ErrCode func ttl(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("TTL", key))?;
return v.as_int();@briefProvides the system library operation `Conn.ttl`.
@detailsExecutes the `ttl` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.scan
Signature
func scan(self: net.redis.Conn, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func scan(self: net.redis.Conn, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("SCAN");@briefProvides the system library operation `Conn.scan`.
@detailsExecutes the `scan` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- cursorCursor position or server-side cursor token used for incremental iteration.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hget
Signature
func hget(self: net.redis.Conn, key: String, field: String) -> String, ErrCode func hget(self: net.redis.Conn, key: String, field: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HGET", key, field))?;
if v.is_null() {@briefProvides the system library operation `Conn.hget`.
@detailsExecutes the `hget` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hset
Signature
func hset(self: net.redis.Conn, key: String, field: String, value: String) -> Int, ErrCode func hset(self: net.redis.Conn, key: String, field: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HSET", key, field, value))?;
return v.as_int();@briefProvides the system library operation `Conn.hset`.
@detailsExecutes the `hset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hset_many
Signature
func hset_many(self: net.redis.Conn, key: String, field_values: collections.Vector<String>) -> Int, ErrCode func hset_many(self: net.redis.Conn, key: String, field_values: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("HSET", key, field_values))?;
return v.as_int();@briefProvides the system library operation `Conn.hset_many`.
@detailsExecutes the `hset_many` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- field_valuesFlat collection of alternating field names and values.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hmget
Signature
func hmget(self: net.redis.Conn, key: String, fields: collections.Vector<String>) -> net.redis.ResultList, ErrCode func hmget(self: net.redis.Conn, key: String, fields: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("HMGET", key, fields))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.hmget`.
@detailsExecutes the `hmget` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldsCollection of field names or field descriptors processed by the operation.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hgetall
Signature
func hgetall(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode func hgetall(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HGETALL", key))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.hgetall`.
@detailsExecutes the `hgetall` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hdel
Signature
func hdel(self: net.redis.Conn, key: String, fields: collections.Vector<String>) -> Int, ErrCode func hdel(self: net.redis.Conn, key: String, fields: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("HDEL", key, fields))?;
return v.as_int();@briefProvides the system library operation `Conn.hdel`.
@detailsExecutes the `hdel` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldsCollection of field names or field descriptors processed by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lpush
Signature
func lpush(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode func lpush(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LPUSH", key, value))?;
return v.as_int();@briefProvides the system library operation `Conn.lpush`.
@detailsExecutes the `lpush` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.rpush
Signature
func rpush(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode func rpush(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RPUSH", key, value))?;
return v.as_int();@briefProvides the system library operation `Conn.rpush`.
@detailsExecutes the `rpush` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lpop
Signature
func lpop(self: net.redis.Conn, key: String) -> String, ErrCode func lpop(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LPOP", key))?;
if v.is_null() {@briefProvides the system library operation `Conn.lpop`.
@detailsExecutes the `lpop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.rpop
Signature
func rpop(self: net.redis.Conn, key: String) -> String, ErrCode func rpop(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RPOP", key))?;
if v.is_null() {@briefProvides the system library operation `Conn.rpop`.
@detailsExecutes the `rpop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.blpop
Signature
func blpop(self: net.redis.Conn, keys: collections.Vector<String>, timeout_sec: Float64) -> protocol.redis.RespValue, ErrCode func blpop(self: net.redis.Conn, keys: collections.Vector<String>, timeout_sec: Float64) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_with_values("BLPOP", keys);
_ = args.push(strconv.format_float64(timeout_sec));@briefProvides the system library operation `Conn.blpop`.
@detailsExecutes the `blpop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- timeout_secTimeout duration in seconds before the operation is considered failed.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.brpop
Signature
func brpop(self: net.redis.Conn, keys: collections.Vector<String>, timeout_sec: Float64) -> protocol.redis.RespValue, ErrCode func brpop(self: net.redis.Conn, keys: collections.Vector<String>, timeout_sec: Float64) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_with_values("BRPOP", keys);
_ = args.push(strconv.format_float64(timeout_sec));@briefProvides the system library operation `Conn.brpop`.
@detailsExecutes the `brpop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- timeout_secTimeout duration in seconds before the operation is considered failed.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sadd
Signature
func sadd(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode func sadd(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SADD", key, member))?;
return v.as_int();@briefProvides the system library operation `Conn.sadd`.
@detailsExecutes the `sadd` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.srem
Signature
func srem(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> Int, ErrCode func srem(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("SREM", key, members))?;
return v.as_int();@briefProvides the system library operation `Conn.srem`.
@detailsExecutes the `srem` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- membersCollection of set or sorted-set members processed by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.smembers
Signature
func smembers(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode func smembers(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SMEMBERS", key))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.smembers`.
@detailsExecutes the `smembers` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sismember
Signature
func sismember(self: net.redis.Conn, key: String, member: String) -> Bool, ErrCode func sismember(self: net.redis.Conn, key: String, member: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SISMEMBER", key, member))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.sismember`.
@detailsExecutes the `sismember` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zadd
Signature
func zadd(self: net.redis.Conn, key: String, score: Float64, member: String) -> Int, ErrCode func zadd(self: net.redis.Conn, key: String, score: Float64, member: String) -> Int, ErrCode {
return self.zadd_raw(key, strconv.format_float64(score), member);
}@briefProvides the system library operation `Conn.zadd`.
@detailsExecutes the `zadd` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- scoreSorted-set score or numeric ranking value associated with a member.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zadd_raw
Signature
func zadd_raw(self: net.redis.Conn, key: String, score_text: String, member: String) -> Int, ErrCode func zadd_raw(self: net.redis.Conn, key: String, score_text: String, member: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZADD", key, score_text, member))?;
return v.as_int();@briefProvides the system library operation `Conn.zadd_raw`.
@detailsExecutes the `zadd_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- score_textText representation of a sorted-set score encoded into a command.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrange
Signature
func zrange(self: net.redis.Conn, key: String, start: Int, stop: Int, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrange(self: net.redis.Conn, key: String, start: Int, stop: Int, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZRANGE", key, strconv.itoa(start), strconv.itoa(stop));
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.zrange`.
@detailsExecutes the `zrange` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- stopStop boundary, stop index, or termination value for the operation.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrem
Signature
func zrem(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> Int, ErrCode func zrem(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("ZREM", key, members))?;
return v.as_int();@briefProvides the system library operation `Conn.zrem`.
@detailsExecutes the `zrem` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- membersCollection of set or sorted-set members processed by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zscore
Signature
func zscore(self: net.redis.Conn, key: String, member: String) -> String, ErrCode func zscore(self: net.redis.Conn, key: String, member: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZSCORE", key, member))?;
if v.is_null() {@briefProvides the system library operation `Conn.zscore`.
@detailsExecutes the `zscore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zscore_float64
Signature
func zscore_float64(self: net.redis.Conn, key: String, member: String) -> Float64, ErrCode func zscore_float64(self: net.redis.Conn, key: String, member: String) -> Float64, ErrCode {
let text: String = self.zscore(key, member)?;
return strconv.parse_float64(text), std.OK;@briefProvides the system library operation `Conn.zscore_float64`.
@detailsExecutes the `zscore_float64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Float64, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.multi
Signature
func multi(self: net.redis.Conn) -> ErrCode func multi(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("MULTI"));
if err != std.OK {@briefProvides the system library operation `Conn.multi`.
@detailsExecutes the `multi` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.exec
Signature
func exec(self: net.redis.Conn) -> net.redis.ResultList, ErrCode func exec(self: net.redis.Conn) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("EXEC"))?;
if v.kind != protocol.redis.RESP_ARRAY {@briefProvides the system library operation `Conn.exec`.
@detailsExecutes the `exec` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.discard
Signature
func discard(self: net.redis.Conn) -> ErrCode func discard(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("DISCARD"));
if err != std.OK {@briefProvides the system library operation `Conn.discard`.
@detailsExecutes the `discard` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.watch
Signature
func watch(self: net.redis.Conn, keys: collections.Vector<String>) -> ErrCode func watch(self: net.redis.Conn, keys: collections.Vector<String>) -> ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("WATCH");@briefProvides the system library operation `Conn.watch`.
@detailsExecutes the `watch` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.unwatch
Signature
func unwatch(self: net.redis.Conn) -> ErrCode func unwatch(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("UNWATCH"));
if err != std.OK {@briefProvides the system library operation `Conn.unwatch`.
@detailsExecutes the `unwatch` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.eval
Signature
func eval(self: net.redis.Conn, script: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func eval(self: net.redis.Conn, script: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.eval_like("EVAL", script, keys, args_in);
}@briefProvides the system library operation `Conn.eval`.
@detailsExecutes the `eval` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- scriptScript text or script identifier executed by the server or runtime.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.evalsha
Signature
func evalsha(self: net.redis.Conn, sha: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func evalsha(self: net.redis.Conn, sha: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.eval_like("EVALSHA", sha, keys, args_in);
}@briefProvides the system library operation `Conn.evalsha`.
@detailsExecutes the `evalsha` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- shaScript SHA hash used to identify a cached server-side script.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.eval_like
Signature
func eval_like(self: net.redis.Conn, command_name: String, script_or_sha: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func eval_like(self: net.redis.Conn, command_name: String, script_or_sha: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push(command_name);@briefProvides the system library operation `Conn.eval_like`.
@detailsExecutes the `eval_like` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- command_nameProtocol command name to encode, send, dispatch, or execute.
- script_or_shaScript text or SHA hash accepted by the script execution command.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.script_load
Signature
func script_load(self: net.redis.Conn, script: String) -> String, ErrCode func script_load(self: net.redis.Conn, script: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SCRIPT", "LOAD", script))?;
if v.is_error() {@briefProvides the system library operation `Conn.script_load`.
@detailsExecutes the `script_load` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- scriptScript text or script identifier executed by the server or runtime.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.publish
Signature
func publish(self: net.redis.Conn, channel: String, message: String) -> Int, ErrCode func publish(self: net.redis.Conn, channel: String, message: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("PUBLISH", channel, message))?;
return v.as_int();@briefProvides the system library operation `Conn.publish`.
@detailsExecutes the `publish` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- channelChannel name used by publish, subscribe, or message routing operations.
- messageMessage text or payload delivered to the caller, log, or protocol peer.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xadd
Signature
func xadd(self: net.redis.Conn, key: String, id: String, field: String, value: String) -> String, ErrCode func xadd(self: net.redis.Conn, key: String, id: String, field: String, value: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("XADD", key, id, field, value))?;
return v.as_string();@briefProvides the system library operation `Conn.xadd`.
@detailsExecutes the `xadd` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- idIdentifier value used to select a record, statement, handle, request, or resource.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
- valueValue to write or store.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xadd_fields
Signature
func xadd_fields(self: net.redis.Conn, key: String, id: String, field_values: collections.Vector<String>) -> String, ErrCode func xadd_fields(self: net.redis.Conn, key: String, id: String, field_values: collections.Vector<String>) -> String, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("XADD");@briefProvides the system library operation `Conn.xadd_fields`.
@detailsExecutes the `xadd_fields` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- idIdentifier value used to select a record, statement, handle, request, or resource.
- field_valuesFlat collection of alternating field names and values.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xread
Signature
func xread(self: net.redis.Conn, options_and_streams: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func xread(self: net.redis.Conn, options_and_streams: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("XREAD", options_and_streams));
}@briefProvides the system library operation `Conn.xread`.
@detailsExecutes the `xread` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- options_and_streamsCombined option and stream definitions encoded for the protocol command.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xgroup
Signature
func xgroup(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func xgroup(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("XGROUP", args_in));
}@briefProvides the system library operation `Conn.xgroup`.
@detailsExecutes the `xgroup` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xreadgroup
Signature
func xreadgroup(self: net.redis.Conn, options_and_streams: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func xreadgroup(self: net.redis.Conn, options_and_streams: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("XREADGROUP", options_and_streams));
}@briefProvides the system library operation `Conn.xreadgroup`.
@detailsExecutes the `xreadgroup` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- options_and_streamsCombined option and stream definitions encoded for the protocol command.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.xack
Signature
func xack(self: net.redis.Conn, key: String, group: String, id: String) -> Int, ErrCode func xack(self: net.redis.Conn, key: String, group: String, id: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("XACK", key, group, id))?;
return v.as_int();@briefProvides the system library operation `Conn.xack`.
@detailsExecutes the `xack` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- groupConsumer group name or logical group identifier used by the operation.
- idIdentifier value used to select a record, statement, handle, request, or resource.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geoadd
Signature
func geoadd(self: net.redis.Conn, key: String, longitude: Float64, latitude: Float64, member: String) -> Int, ErrCode func geoadd(self: net.redis.Conn, key: String, longitude: Float64, latitude: Float64, member: String) -> Int, ErrCode {
return self.geoadd_raw(key, strconv.format_float64(longitude), strconv.format_float64(latitude), member);
}@briefProvides the system library operation `Conn.geoadd`.
@detailsExecutes the `geoadd` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- longitudeLongitude coordinate value used by geospatial operations.
- latitudeLatitude coordinate value used by geospatial operations.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geoadd_raw
Signature
func geoadd_raw(self: net.redis.Conn, key: String, longitude_text: String, latitude_text: String, member: String) -> Int, ErrCode func geoadd_raw(self: net.redis.Conn, key: String, longitude_text: String, latitude_text: String, member: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GEOADD", key, longitude_text, latitude_text, member))?;
return v.as_int();@briefProvides the system library operation `Conn.geoadd_raw`.
@detailsExecutes the `geoadd_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- longitude_textText representation of the longitude coordinate encoded into a command.
- latitude_textText representation of the latitude coordinate encoded into a command.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geopos
Signature
func geopos(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func geopos(self: net.redis.Conn, key: String, members: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_key_values("GEOPOS", key, members));
}@briefProvides the system library operation `Conn.geopos`.
@detailsExecutes the `geopos` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- membersCollection of set or sorted-set members processed by the operation.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geodist
Signature
func geodist(self: net.redis.Conn, key: String, member1: String, member2: String, unit: String) -> String, ErrCode func geodist(self: net.redis.Conn, key: String, member1: String, member2: String, unit: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GEODIST", key, member1, member2, unit))?;
if v.is_null() {@briefProvides the system library operation `Conn.geodist`.
@detailsExecutes the `geodist` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- member1First member value used by a two-member set or sorted-set operation.
- member2Second member value used by a two-member set or sorted-set operation.
- unitUnit selector that determines how the numeric value is interpreted.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geodist_float64
Signature
func geodist_float64(self: net.redis.Conn, key: String, member1: String, member2: String, unit: String) -> Float64, ErrCode func geodist_float64(self: net.redis.Conn, key: String, member1: String, member2: String, unit: String) -> Float64, ErrCode {
let text: String = self.geodist(key, member1, member2, unit)?;
return strconv.parse_float64(text), std.OK;@briefProvides the system library operation `Conn.geodist_float64`.
@detailsExecutes the `geodist_float64` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- member1First member value used by a two-member set or sorted-set operation.
- member2Second member value used by a two-member set or sorted-set operation.
- unitUnit selector that determines how the numeric value is interpreted.
@returnReturns `Float64, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.geosearch
Signature
func geosearch(self: net.redis.Conn, key: String, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func geosearch(self: net.redis.Conn, key: String, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_key_values("GEOSEARCH", key, args_in));
}@briefProvides the system library operation `Conn.geosearch`.
@detailsExecutes the `geosearch` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pfadd
Signature
func pfadd(self: net.redis.Conn, key: String, elements: collections.Vector<String>) -> Int, ErrCode func pfadd(self: net.redis.Conn, key: String, elements: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("PFADD", key, elements))?;
return v.as_int();@briefProvides the system library operation `Conn.pfadd`.
@detailsExecutes the `pfadd` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- elementsCollection of elements inserted, removed, searched, encoded, or returned.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pfcount
Signature
func pfcount(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode func pfcount(self: net.redis.Conn, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("PFCOUNT", keys))?;
return v.as_int();@briefProvides the system library operation `Conn.pfcount`.
@detailsExecutes the `pfcount` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pfmerge
Signature
func pfmerge(self: net.redis.Conn, destkey: String, sourcekeys: collections.Vector<String>) -> ErrCode func pfmerge(self: net.redis.Conn, destkey: String, sourcekeys: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_key_values("PFMERGE", destkey, sourcekeys));
if err != std.OK {@briefProvides the system library operation `Conn.pfmerge`.
@detailsExecutes the `pfmerge` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destkeyDestination key that receives the result of the key-based operation.
- sourcekeysKey name, key material, or key collection used by the operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.setbit
Signature
func setbit(self: net.redis.Conn, key: String, offset: Int, bit: Int) -> Int, ErrCode func setbit(self: net.redis.Conn, key: String, offset: Int, bit: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SETBIT", key, strconv.itoa(offset), strconv.itoa(bit)))?;
return v.as_int();@briefProvides the system library operation `Conn.setbit`.
@detailsExecutes the `setbit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- offsetByte offset measured from the start position.
- bitBit value or bit index addressed by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.getbit
Signature
func getbit(self: net.redis.Conn, key: String, offset: Int) -> Int, ErrCode func getbit(self: net.redis.Conn, key: String, offset: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GETBIT", key, strconv.itoa(offset)))?;
return v.as_int();@briefProvides the system library operation `Conn.getbit`.
@detailsExecutes the `getbit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- offsetByte offset measured from the start position.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.bitcount
Signature
func bitcount(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> Int, ErrCode func bitcount(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("BITCOUNT", key, options))?;
return v.as_int();@briefProvides the system library operation `Conn.bitcount`.
@detailsExecutes the `bitcount` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.bitop
Signature
func bitop(self: net.redis.Conn, operation: String, destkey: String, keys: collections.Vector<String>) -> Int, ErrCode func bitop(self: net.redis.Conn, operation: String, destkey: String, keys: collections.Vector<String>) -> Int, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("BITOP");@briefProvides the system library operation `Conn.bitop`.
@detailsExecutes the `bitop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- operationOperation name or operation code selected by the caller.
- destkeyDestination key that receives the result of the key-based operation.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.bitpos
Signature
func bitpos(self: net.redis.Conn, key: String, bit: Int, options: collections.Vector<String>) -> Int, ErrCode func bitpos(self: net.redis.Conn, key: String, bit: Int, options: collections.Vector<String>) -> Int, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("BITPOS", key, strconv.itoa(bit));
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.bitpos`.
@detailsExecutes the `bitpos` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- bitBit value or bit index addressed by the operation.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.acl
Signature
func acl(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func acl(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("ACL", args_in));
}@briefProvides the system library operation `Conn.acl`.
@detailsExecutes the `acl` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.acl_whoami
Signature
func acl_whoami(self: net.redis.Conn) -> String, ErrCode func acl_whoami(self: net.redis.Conn) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ACL", "WHOAMI"))?;
return v.as_string();@briefProvides the system library operation `Conn.acl_whoami`.
@detailsExecutes the `acl_whoami` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.fcall
Signature
func fcall(self: net.redis.Conn, function_name: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func fcall(self: net.redis.Conn, function_name: String, keys: collections.Vector<String>, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("FCALL");@briefProvides the system library operation `Conn.fcall`.
@detailsExecutes the `fcall` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- function_nameFunction name used for lookup, dispatch, tracing, or reflection.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.function_load
Signature
func function_load(self: net.redis.Conn, library_code: String, replace: Bool = false) -> String, ErrCode func function_load(self: net.redis.Conn, library_code: String, replace: Bool = false) -> String, ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push("FUNCTION");@briefProvides the system library operation `Conn.function_load`.
@detailsExecutes the `function_load` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- library_codeLibrary-specific numeric code used for error reporting or dispatch.
- replaceWhether an existing value should be replaced when a target already exists.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.dump
Signature
func dump(self: net.redis.Conn, key: String) -> String, ErrCode func dump(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DUMP", key))?;
if v.is_null() {@briefProvides the system library operation `Conn.dump`.
@detailsExecutes the `dump` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.expireat
Signature
func expireat(self: net.redis.Conn, key: String, unix_time_sec: Int) -> Bool, ErrCode func expireat(self: net.redis.Conn, key: String, unix_time_sec: Int) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("EXPIREAT", key, strconv.itoa(unix_time_sec)))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.expireat`.
@detailsExecutes the `expireat` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- unix_time_secTimeout or duration value in seconds for unix time.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.keys
Signature
func keys(self: net.redis.Conn, pattern: String) -> net.redis.ResultList, ErrCode func keys(self: net.redis.Conn, pattern: String) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("KEYS", pattern))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.keys`.
@detailsExecutes the `keys` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- patternPattern string used to match, filter, or route input values.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.migrate
Signature
func migrate(self: net.redis.Conn, host: String, port: Int, key: String, dest_db: Int, timeout_ms: Int, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func migrate(self: net.redis.Conn, host: String, port: Int, key: String, dest_db: Int, timeout_ms: Int, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("MIGRATE", host, strconv.itoa(port), key, strconv.itoa(dest_db), strconv.itoa(timeout_ms));
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.migrate`.
@detailsExecutes the `migrate` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- hostHost name or listen address.
- portPort number.
- keyKey name.
- dest_dbDestination database index or name used by migration and copy commands.
- timeout_msTimeout in milliseconds; negative values usually select blocking or default timeout behavior.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.move
Signature
func move(self: net.redis.Conn, key: String, database: Int) -> Bool, ErrCode func move(self: net.redis.Conn, key: String, database: Int) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("MOVE", key, strconv.itoa(database)))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.move`.
@detailsExecutes the `move` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- databaseDatabase name or database index selected for the connection or command.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.object_info
Signature
func object_info(self: net.redis.Conn, subcommand: String, key: String) -> protocol.redis.RespValue, ErrCode func object_info(self: net.redis.Conn, subcommand: String, key: String) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("OBJECT", subcommand, key));
}@briefProvides the system library operation `Conn.object_info`.
@detailsExecutes the `object_info` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- subcommandSubcommand name encoded as part of the protocol command.
- keyKey name.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.persist
Signature
func persist(self: net.redis.Conn, key: String) -> Bool, ErrCode func persist(self: net.redis.Conn, key: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("PERSIST", key))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.persist`.
@detailsExecutes the `persist` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pexpire
Signature
func pexpire(self: net.redis.Conn, key: String, ttl_ms: Int) -> Bool, ErrCode func pexpire(self: net.redis.Conn, key: String, ttl_ms: Int) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("PEXPIRE", key, strconv.itoa(ttl_ms)))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.pexpire`.
@detailsExecutes the `pexpire` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- ttl_msTime interval or timeout value in milliseconds.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pexpireat
Signature
func pexpireat(self: net.redis.Conn, key: String, unix_time_ms: Int) -> Bool, ErrCode func pexpireat(self: net.redis.Conn, key: String, unix_time_ms: Int) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("PEXPIREAT", key, strconv.itoa(unix_time_ms)))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.pexpireat`.
@detailsExecutes the `pexpireat` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- unix_time_msTime interval or timeout value in milliseconds.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pttl
Signature
func pttl(self: net.redis.Conn, key: String) -> Int, ErrCode func pttl(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("PTTL", key))?;
return v.as_int();@briefProvides the system library operation `Conn.pttl`.
@detailsExecutes the `pttl` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.randomkey
Signature
func randomkey(self: net.redis.Conn) -> String, ErrCode func randomkey(self: net.redis.Conn) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RANDOMKEY"))?;
if v.is_null() {@briefProvides the system library operation `Conn.randomkey`.
@detailsExecutes the `randomkey` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.rename
Signature
func rename(self: net.redis.Conn, key: String, new_key: String) -> ErrCode func rename(self: net.redis.Conn, key: String, new_key: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("RENAME", key, new_key));
if err != std.OK {@briefProvides the system library operation `Conn.rename`.
@detailsExecutes the `rename` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- new_keyNew key name assigned by a rename or migration operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.renamenx
Signature
func renamenx(self: net.redis.Conn, key: String, new_key: String) -> Bool, ErrCode func renamenx(self: net.redis.Conn, key: String, new_key: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RENAMENX", key, new_key))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.renamenx`.
@detailsExecutes the `renamenx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- new_keyNew key name assigned by a rename or migration operation.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.restore
Signature
func restore(self: net.redis.Conn, key: String, ttl_ms: Int, serialized_value: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func restore(self: net.redis.Conn, key: String, ttl_ms: Int, serialized_value: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("RESTORE", key, strconv.itoa(ttl_ms), serialized_value);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.restore`.
@detailsExecutes the `restore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- ttl_msTime interval or timeout value in milliseconds.
- serialized_valueValue supplied by the caller for storage, comparison, or encoding.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sort
Signature
func sort(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func sort(self: net.redis.Conn, key: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_key_values("SORT", key, options));
}@briefProvides the system library operation `Conn.sort`.
@detailsExecutes the `sort` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.key_type
Signature
func key_type(self: net.redis.Conn, key: String) -> String, ErrCode func key_type(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("TYPE", key))?;
return v.as_string();@briefProvides the system library operation `Conn.key_type`.
@detailsExecutes the `key_type` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.append
Signature
func append(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode func append(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("APPEND", key, value))?;
return v.as_int();@briefProvides the system library operation `Conn.append`.
@detailsExecutes the `append` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.decrby
Signature
func decrby(self: net.redis.Conn, key: String, decrement: Int) -> Int, ErrCode func decrby(self: net.redis.Conn, key: String, decrement: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DECRBY", key, strconv.itoa(decrement)))?;
return v.as_int();@briefProvides the system library operation `Conn.decrby`.
@detailsExecutes the `decrby` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- decrementUnsigned amount by which the stored numeric value is decreased.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.getrange
Signature
func getrange(self: net.redis.Conn, key: String, start: Int, end: Int) -> String, ErrCode func getrange(self: net.redis.Conn, key: String, start: Int, end: Int) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GETRANGE", key, strconv.itoa(start), strconv.itoa(end)))?;
return v.as_string();@briefProvides the system library operation `Conn.getrange`.
@detailsExecutes the `getrange` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- endEnd index, byte offset, or range boundary for the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.getset
Signature
func getset(self: net.redis.Conn, key: String, value: String) -> String, ErrCode func getset(self: net.redis.Conn, key: String, value: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("GETSET", key, value))?;
if v.is_null() {@briefProvides the system library operation `Conn.getset`.
@detailsExecutes the `getset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.incrby
Signature
func incrby(self: net.redis.Conn, key: String, increment: Int) -> Int, ErrCode func incrby(self: net.redis.Conn, key: String, increment: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("INCRBY", key, strconv.itoa(increment)))?;
return v.as_int();@briefProvides the system library operation `Conn.incrby`.
@detailsExecutes the `incrby` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- incrementUnsigned amount by which the stored numeric value is increased.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.incrbyfloat
Signature
func incrbyfloat(self: net.redis.Conn, key: String, increment: String) -> String, ErrCode func incrbyfloat(self: net.redis.Conn, key: String, increment: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("INCRBYFLOAT", key, increment))?;
return v.as_string();@briefProvides the system library operation `Conn.incrbyfloat`.
@detailsExecutes the `incrbyfloat` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- incrementUnsigned amount by which the stored numeric value is increased.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.msetnx
Signature
func msetnx(self: net.redis.Conn, key_values: collections.Vector<String>) -> Bool, ErrCode func msetnx(self: net.redis.Conn, key_values: collections.Vector<String>) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("MSETNX", key_values))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.msetnx`.
@detailsExecutes the `msetnx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- key_valuesFlat collection of alternating keys and values.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.psetex
Signature
func psetex(self: net.redis.Conn, key: String, ttl_ms: Int, value: String) -> ErrCode func psetex(self: net.redis.Conn, key: String, ttl_ms: Int, value: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("PSETEX", key, strconv.itoa(ttl_ms), value));
if err != std.OK {@briefProvides the system library operation `Conn.psetex`.
@detailsExecutes the `psetex` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- ttl_msTime interval or timeout value in milliseconds.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.setex
Signature
func setex(self: net.redis.Conn, key: String, ttl_sec: Int, value: String) -> ErrCode func setex(self: net.redis.Conn, key: String, ttl_sec: Int, value: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("SETEX", key, strconv.itoa(ttl_sec), value));
if err != std.OK {@briefProvides the system library operation `Conn.setex`.
@detailsExecutes the `setex` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- ttl_secTime-to-live duration in seconds before the stored value or protocol entry expires.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.setnx
Signature
func setnx(self: net.redis.Conn, key: String, value: String) -> Bool, ErrCode func setnx(self: net.redis.Conn, key: String, value: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SETNX", key, value))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.setnx`.
@detailsExecutes the `setnx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.setrange
Signature
func setrange(self: net.redis.Conn, key: String, offset: Int, value: String) -> Int, ErrCode func setrange(self: net.redis.Conn, key: String, offset: Int, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SETRANGE", key, strconv.itoa(offset), value))?;
return v.as_int();@briefProvides the system library operation `Conn.setrange`.
@detailsExecutes the `setrange` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- offsetByte offset measured from the start position.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.strlen
Signature
func strlen(self: net.redis.Conn, key: String) -> Int, ErrCode func strlen(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("STRLEN", key))?;
return v.as_int();@briefProvides the system library operation `Conn.strlen`.
@detailsExecutes the `strlen` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hexists
Signature
func hexists(self: net.redis.Conn, key: String, field: String) -> Bool, ErrCode func hexists(self: net.redis.Conn, key: String, field: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HEXISTS", key, field))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.hexists`.
@detailsExecutes the `hexists` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hincrby
Signature
func hincrby(self: net.redis.Conn, key: String, field: String, increment: Int) -> Int, ErrCode func hincrby(self: net.redis.Conn, key: String, field: String, increment: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HINCRBY", key, field, strconv.itoa(increment)))?;
return v.as_int();@briefProvides the system library operation `Conn.hincrby`.
@detailsExecutes the `hincrby` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
- incrementUnsigned amount by which the stored numeric value is increased.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hincrbyfloat
Signature
func hincrbyfloat(self: net.redis.Conn, key: String, field: String, increment: String) -> String, ErrCode func hincrbyfloat(self: net.redis.Conn, key: String, field: String, increment: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HINCRBYFLOAT", key, field, increment))?;
return v.as_string();@briefProvides the system library operation `Conn.hincrbyfloat`.
@detailsExecutes the `hincrbyfloat` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
- incrementUnsigned amount by which the stored numeric value is increased.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hkeys
Signature
func hkeys(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode func hkeys(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HKEYS", key))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.hkeys`.
@detailsExecutes the `hkeys` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hlen
Signature
func hlen(self: net.redis.Conn, key: String) -> Int, ErrCode func hlen(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HLEN", key))?;
return v.as_int();@briefProvides the system library operation `Conn.hlen`.
@detailsExecutes the `hlen` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hmset
Signature
func hmset(self: net.redis.Conn, key: String, field_values: collections.Vector<String>) -> ErrCode func hmset(self: net.redis.Conn, key: String, field_values: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_key_values("HMSET", key, field_values));
if err != std.OK {@briefProvides the system library operation `Conn.hmset`.
@detailsExecutes the `hmset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- field_valuesFlat collection of alternating field names and values.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hsetnx
Signature
func hsetnx(self: net.redis.Conn, key: String, field: String, value: String) -> Bool, ErrCode func hsetnx(self: net.redis.Conn, key: String, field: String, value: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HSETNX", key, field, value))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.hsetnx`.
@detailsExecutes the `hsetnx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- fieldField name or field index selected within a record, map, hash, or protocol frame.
- valueValue to write or store.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hvals
Signature
func hvals(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode func hvals(self: net.redis.Conn, key: String) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("HVALS", key))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.hvals`.
@detailsExecutes the `hvals` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.hscan
Signature
func hscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func hscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("HSCAN", key, cursor);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.hscan`.
@detailsExecutes the `hscan` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- cursorCursor position or server-side cursor token used for incremental iteration.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.brpoplpush
Signature
func brpoplpush(self: net.redis.Conn, source: String, destination: String, timeout_sec: Float64) -> String, ErrCode func brpoplpush(self: net.redis.Conn, source: String, destination: String, timeout_sec: Float64) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("BRPOPLPUSH", source, destination, strconv.format_float64(timeout_sec)))?;
if v.is_null() {@briefProvides the system library operation `Conn.brpoplpush`.
@detailsExecutes the `brpoplpush` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- sourceSource path, stream, buffer, collection, or endpoint read by the operation.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- timeout_secTimeout duration in seconds before the operation is considered failed.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lindex
Signature
func lindex(self: net.redis.Conn, key: String, index: Int) -> String, ErrCode func lindex(self: net.redis.Conn, key: String, index: Int) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LINDEX", key, strconv.itoa(index)))?;
if v.is_null() {@briefProvides the system library operation `Conn.lindex`.
@detailsExecutes the `lindex` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- indexZero-based index.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.linsert
Signature
func linsert(self: net.redis.Conn, key: String, where_pos: String, pivot: String, value: String) -> Int, ErrCode func linsert(self: net.redis.Conn, key: String, where_pos: String, pivot: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LINSERT", key, where_pos, pivot, value))?;
return v.as_int();@briefProvides the system library operation `Conn.linsert`.
@detailsExecutes the `linsert` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- where_posInsertion position selector used by list operations such as before or after a pivot.
- pivotExisting list element used as the insertion reference point.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.llen
Signature
func llen(self: net.redis.Conn, key: String) -> Int, ErrCode func llen(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LLEN", key))?;
return v.as_int();@briefProvides the system library operation `Conn.llen`.
@detailsExecutes the `llen` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lpushx
Signature
func lpushx(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode func lpushx(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LPUSHX", key, value))?;
return v.as_int();@briefProvides the system library operation `Conn.lpushx`.
@detailsExecutes the `lpushx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lrange
Signature
func lrange(self: net.redis.Conn, key: String, start: Int, stop: Int) -> net.redis.ResultList, ErrCode func lrange(self: net.redis.Conn, key: String, start: Int, stop: Int) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LRANGE", key, strconv.itoa(start), strconv.itoa(stop)))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.lrange`.
@detailsExecutes the `lrange` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- stopStop boundary, stop index, or termination value for the operation.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lrem
Signature
func lrem(self: net.redis.Conn, key: String, count: Int, value: String) -> Int, ErrCode func lrem(self: net.redis.Conn, key: String, count: Int, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LREM", key, strconv.itoa(count), value))?;
return v.as_int();@briefProvides the system library operation `Conn.lrem`.
@detailsExecutes the `lrem` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- countNumber of elements, bytes, records, or operations requested by the caller.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lset
Signature
func lset(self: net.redis.Conn, key: String, index: Int, value: String) -> ErrCode func lset(self: net.redis.Conn, key: String, index: Int, value: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("LSET", key, strconv.itoa(index), value));
if err != std.OK {@briefProvides the system library operation `Conn.lset`.
@detailsExecutes the `lset` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- indexZero-based index.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.ltrim
Signature
func ltrim(self: net.redis.Conn, key: String, start: Int, stop: Int) -> ErrCode func ltrim(self: net.redis.Conn, key: String, start: Int, stop: Int) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("LTRIM", key, strconv.itoa(start), strconv.itoa(stop)));
if err != std.OK {@briefProvides the system library operation `Conn.ltrim`.
@detailsExecutes the `ltrim` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- stopStop boundary, stop index, or termination value for the operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.rpoplpush
Signature
func rpoplpush(self: net.redis.Conn, source: String, destination: String) -> String, ErrCode func rpoplpush(self: net.redis.Conn, source: String, destination: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RPOPLPUSH", source, destination))?;
if v.is_null() {@briefProvides the system library operation `Conn.rpoplpush`.
@detailsExecutes the `rpoplpush` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- sourceSource path, stream, buffer, collection, or endpoint read by the operation.
- destinationDestination path, address, queue, or buffer that receives the produced data.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.rpushx
Signature
func rpushx(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode func rpushx(self: net.redis.Conn, key: String, value: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("RPUSHX", key, value))?;
return v.as_int();@briefProvides the system library operation `Conn.rpushx`.
@detailsExecutes the `rpushx` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- valueValue to write or store.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.scard
Signature
func scard(self: net.redis.Conn, key: String) -> Int, ErrCode func scard(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SCARD", key))?;
return v.as_int();@briefProvides the system library operation `Conn.scard`.
@detailsExecutes the `scard` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sdiff
Signature
func sdiff(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode func sdiff(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("SDIFF", keys))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.sdiff`.
@detailsExecutes the `sdiff` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sdiffstore
Signature
func sdiffstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode func sdiffstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("SDIFFSTORE", destination, keys))?;
return v.as_int();@briefProvides the system library operation `Conn.sdiffstore`.
@detailsExecutes the `sdiffstore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sinter
Signature
func sinter(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode func sinter(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("SINTER", keys))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.sinter`.
@detailsExecutes the `sinter` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sinterstore
Signature
func sinterstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode func sinterstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("SINTERSTORE", destination, keys))?;
return v.as_int();@briefProvides the system library operation `Conn.sinterstore`.
@detailsExecutes the `sinterstore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.smove
Signature
func smove(self: net.redis.Conn, source: String, destination: String, member: String) -> Bool, ErrCode func smove(self: net.redis.Conn, source: String, destination: String, member: String) -> Bool, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SMOVE", source, destination, member))?;
let n: Int = v.as_int()?;@briefProvides the system library operation `Conn.smove`.
@detailsExecutes the `smove` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- sourceSource path, stream, buffer, collection, or endpoint read by the operation.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Bool, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.spop
Signature
func spop(self: net.redis.Conn, key: String) -> String, ErrCode func spop(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("SPOP", key))?;
if v.is_null() {@briefProvides the system library operation `Conn.spop`.
@detailsExecutes the `spop` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.spop_count
Signature
func spop_count(self: net.redis.Conn, key: String, count: Int) -> protocol.redis.RespValue, ErrCode func spop_count(self: net.redis.Conn, key: String, count: Int) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("SPOP", key, strconv.itoa(count)));
}@briefProvides the system library operation `Conn.spop_count`.
@detailsExecutes the `spop_count` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- countNumber of elements, bytes, records, or operations requested by the caller.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.srandmember
Signature
func srandmember(self: net.redis.Conn, key: String, count: Int = 0) -> protocol.redis.RespValue, ErrCode func srandmember(self: net.redis.Conn, key: String, count: Int = 0) -> protocol.redis.RespValue, ErrCode {
if count == 0 {
return self.command(protocol.redis.command_args("SRANDMEMBER", key));@briefProvides the system library operation `Conn.srandmember`.
@detailsExecutes the `srandmember` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- countNumber of elements, bytes, records, or operations requested by the caller.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sunion
Signature
func sunion(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode func sunion(self: net.redis.Conn, keys: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_values("SUNION", keys))?;
let out: net.redis.ResultList = new net.redis.ResultList();@briefProvides the system library operation `Conn.sunion`.
@detailsExecutes the `sunion` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sunionstore
Signature
func sunionstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode func sunionstore(self: net.redis.Conn, destination: String, keys: collections.Vector<String>) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("SUNIONSTORE", destination, keys))?;
return v.as_int();@briefProvides the system library operation `Conn.sunionstore`.
@detailsExecutes the `sunionstore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- keysCollection of key names addressed by the lookup, mutation, or protocol command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sscan
Signature
func sscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func sscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("SSCAN", key, cursor);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.sscan`.
@detailsExecutes the `sscan` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- cursorCursor position or server-side cursor token used for incremental iteration.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zcard
Signature
func zcard(self: net.redis.Conn, key: String) -> Int, ErrCode func zcard(self: net.redis.Conn, key: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZCARD", key))?;
return v.as_int();@briefProvides the system library operation `Conn.zcard`.
@detailsExecutes the `zcard` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zcount
Signature
func zcount(self: net.redis.Conn, key: String, min_score: String, max_score: String) -> Int, ErrCode func zcount(self: net.redis.Conn, key: String, min_score: String, max_score: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZCOUNT", key, min_score, max_score))?;
return v.as_int();@briefProvides the system library operation `Conn.zcount`.
@detailsExecutes the `zcount` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zcount_scores
Signature
func zcount_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64) -> Int, ErrCode func zcount_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64) -> Int, ErrCode {
return self.zcount(key, strconv.format_float64(min_score), strconv.format_float64(max_score));
}@briefProvides the system library operation `Conn.zcount_scores`.
@detailsExecutes the `zcount_scores` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zincrby
Signature
func zincrby(self: net.redis.Conn, key: String, increment: Float64, member: String) -> Float64, ErrCode func zincrby(self: net.redis.Conn, key: String, increment: Float64, member: String) -> Float64, ErrCode {
let text: String = self.zincrby_raw(key, strconv.format_float64(increment), member)?;
return strconv.parse_float64(text), std.OK;@briefProvides the system library operation `Conn.zincrby`.
@detailsExecutes the `zincrby` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- incrementUnsigned amount by which the stored numeric value is increased.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Float64, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zincrby_raw
Signature
func zincrby_raw(self: net.redis.Conn, key: String, increment_text: String, member: String) -> String, ErrCode func zincrby_raw(self: net.redis.Conn, key: String, increment_text: String, member: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZINCRBY", key, increment_text, member))?;
return v.as_string();@briefProvides the system library operation `Conn.zincrby_raw`.
@detailsExecutes the `zincrby_raw` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- increment_textText form of the increment value encoded into the command.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrangebyscore
Signature
func zrangebyscore(self: net.redis.Conn, key: String, min_score: String, max_score: String, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrangebyscore(self: net.redis.Conn, key: String, min_score: String, max_score: String, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZRANGEBYSCORE", key, min_score, max_score);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.zrangebyscore`.
@detailsExecutes the `zrangebyscore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrangebyscore_scores
Signature
func zrangebyscore_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrangebyscore_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
return self.zrangebyscore(key, strconv.format_float64(min_score), strconv.format_float64(max_score), options);
}@briefProvides the system library operation `Conn.zrangebyscore_scores`.
@detailsExecutes the `zrangebyscore_scores` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrank
Signature
func zrank(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode func zrank(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZRANK", key, member))?;
if v.is_null() {@briefProvides the system library operation `Conn.zrank`.
@detailsExecutes the `zrank` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zremrangebyrank
Signature
func zremrangebyrank(self: net.redis.Conn, key: String, start: Int, stop: Int) -> Int, ErrCode func zremrangebyrank(self: net.redis.Conn, key: String, start: Int, stop: Int) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZREMRANGEBYRANK", key, strconv.itoa(start), strconv.itoa(stop)))?;
return v.as_int();@briefProvides the system library operation `Conn.zremrangebyrank`.
@detailsExecutes the `zremrangebyrank` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- stopStop boundary, stop index, or termination value for the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zremrangebyscore
Signature
func zremrangebyscore(self: net.redis.Conn, key: String, min_score: String, max_score: String) -> Int, ErrCode func zremrangebyscore(self: net.redis.Conn, key: String, min_score: String, max_score: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZREMRANGEBYSCORE", key, min_score, max_score))?;
return v.as_int();@briefProvides the system library operation `Conn.zremrangebyscore`.
@detailsExecutes the `zremrangebyscore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zremrangebyscore_scores
Signature
func zremrangebyscore_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64) -> Int, ErrCode func zremrangebyscore_scores(self: net.redis.Conn, key: String, min_score: Float64, max_score: Float64) -> Int, ErrCode {
return self.zremrangebyscore(key, strconv.format_float64(min_score), strconv.format_float64(max_score));
}@briefProvides the system library operation `Conn.zremrangebyscore_scores`.
@detailsExecutes the `zremrangebyscore_scores` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- max_scoreMaximum allowed count or byte size.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrevrange
Signature
func zrevrange(self: net.redis.Conn, key: String, start: Int, stop: Int, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrevrange(self: net.redis.Conn, key: String, start: Int, stop: Int, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZREVRANGE", key, strconv.itoa(start), strconv.itoa(stop));
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.zrevrange`.
@detailsExecutes the `zrevrange` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- startZero-based starting index, byte offset, or range boundary for the operation.
- stopStop boundary, stop index, or termination value for the operation.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrevrangebyscore
Signature
func zrevrangebyscore(self: net.redis.Conn, key: String, max_score: String, min_score: String, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrevrangebyscore(self: net.redis.Conn, key: String, max_score: String, min_score: String, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZREVRANGEBYSCORE", key, max_score, min_score);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.zrevrangebyscore`.
@detailsExecutes the `zrevrangebyscore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- max_scoreMaximum allowed count or byte size.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrevrangebyscore_scores
Signature
func zrevrangebyscore_scores(self: net.redis.Conn, key: String, max_score: Float64, min_score: Float64, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode func zrevrangebyscore_scores(self: net.redis.Conn, key: String, max_score: Float64, min_score: Float64, options: collections.Vector<String>) -> net.redis.ResultList, ErrCode {
return self.zrevrangebyscore(key, strconv.format_float64(max_score), strconv.format_float64(min_score), options);
}@briefProvides the system library operation `Conn.zrevrangebyscore_scores`.
@detailsExecutes the `zrevrangebyscore_scores` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- max_scoreMaximum allowed count or byte size.
- min_scoreInclusive lower score boundary for sorted-set range operations.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zrevrank
Signature
func zrevrank(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode func zrevrank(self: net.redis.Conn, key: String, member: String) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ZREVRANK", key, member))?;
if v.is_null() {@briefProvides the system library operation `Conn.zrevrank`.
@detailsExecutes the `zrevrank` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- memberSet, sorted-set, or collection member value targeted by the operation.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zunionstore
Signature
func zunionstore(self: net.redis.Conn, destination: String, numkeys: Int, keys_and_options: collections.Vector<String>) -> Int, ErrCode func zunionstore(self: net.redis.Conn, destination: String, numkeys: Int, keys_and_options: collections.Vector<String>) -> Int, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZUNIONSTORE", destination, strconv.itoa(numkeys));
loop (let i: Int = 0; i < keys_and_options.len(); i += 1) {@briefProvides the system library operation `Conn.zunionstore`.
@detailsExecutes the `zunionstore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- numkeysNumber of key arguments included before additional command arguments.
- keys_and_optionsCombined key list and option list encoded for the command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zinterstore
Signature
func zinterstore(self: net.redis.Conn, destination: String, numkeys: Int, keys_and_options: collections.Vector<String>) -> Int, ErrCode func zinterstore(self: net.redis.Conn, destination: String, numkeys: Int, keys_and_options: collections.Vector<String>) -> Int, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZINTERSTORE", destination, strconv.itoa(numkeys));
loop (let i: Int = 0; i < keys_and_options.len(); i += 1) {@briefProvides the system library operation `Conn.zinterstore`.
@detailsExecutes the `zinterstore` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- destinationDestination path, address, queue, or buffer that receives the produced data.
- numkeysNumber of key arguments included before additional command arguments.
- keys_and_optionsCombined key list and option list encoded for the command.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.zscan
Signature
func zscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func zscan(self: net.redis.Conn, key: String, cursor: String, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let args: collections.Vector<String> = protocol.redis.command_args("ZSCAN", key, cursor);
loop (let i: Int = 0; i < options.len(); i += 1) {@briefProvides the system library operation `Conn.zscan`.
@detailsExecutes the `zscan` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- cursorCursor position or server-side cursor token used for incremental iteration.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pubsub
Signature
func pubsub(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func pubsub(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("PUBSUB", args_in));
}@briefProvides the system library operation `Conn.pubsub`.
@detailsExecutes the `pubsub` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.punsubscribe
Signature
func punsubscribe(self: net.redis.Conn, patterns: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func punsubscribe(self: net.redis.Conn, patterns: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command_raw(protocol.redis.command_with_values("PUNSUBSCRIBE", patterns));
}@briefProvides the system library operation `Conn.punsubscribe`.
@detailsExecutes the `punsubscribe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- patternsCollection of pattern strings used for matching or filtering.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.script_exists
Signature
func script_exists(self: net.redis.Conn, shas: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func script_exists(self: net.redis.Conn, shas: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_key_values("SCRIPT", "EXISTS", shas));
}@briefProvides the system library operation `Conn.script_exists`.
@detailsExecutes the `script_exists` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- shasCollection of script SHA hashes sent to the server.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.script_flush
Signature
func script_flush(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode func script_flush(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_key_values("SCRIPT", "FLUSH", options));
if err != std.OK {@briefProvides the system library operation `Conn.script_flush`.
@detailsExecutes the `script_flush` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.script_kill
Signature
func script_kill(self: net.redis.Conn) -> ErrCode func script_kill(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("SCRIPT", "KILL"));
if err != std.OK {@briefProvides the system library operation `Conn.script_kill`.
@detailsExecutes the `script_kill` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.echo
Signature
func echo(self: net.redis.Conn, message: String) -> String, ErrCode func echo(self: net.redis.Conn, message: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("ECHO", message))?;
return v.as_string();@briefProvides the system library operation `Conn.echo`.
@detailsExecutes the `echo` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- messageMessage text or payload delivered to the caller, log, or protocol peer.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.quit
Signature
func quit(self: net.redis.Conn) -> ErrCode func quit(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("QUIT"));
if err != std.OK {@briefProvides the system library operation `Conn.quit`.
@detailsExecutes the `quit` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.bgrewriteaof
Signature
func bgrewriteaof(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func bgrewriteaof(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("BGREWRITEAOF"));
}@briefProvides the system library operation `Conn.bgrewriteaof`.
@detailsExecutes the `bgrewriteaof` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.bgsave
Signature
func bgsave(self: net.redis.Conn, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func bgsave(self: net.redis.Conn, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("BGSAVE", options));
}@briefProvides the system library operation `Conn.bgsave`.
@detailsExecutes the `bgsave` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.client_getname
Signature
func client_getname(self: net.redis.Conn) -> String, ErrCode func client_getname(self: net.redis.Conn) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("CLIENT", "GETNAME"))?;
if v.is_null() {@briefProvides the system library operation `Conn.client_getname`.
@detailsExecutes the `client_getname` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.client_kill
Signature
func client_kill(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func client_kill(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_key_values("CLIENT", "KILL", args_in));
}@briefProvides the system library operation `Conn.client_kill`.
@detailsExecutes the `client_kill` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.client_list
Signature
func client_list(self: net.redis.Conn, options: collections.Vector<String>) -> String, ErrCode func client_list(self: net.redis.Conn, options: collections.Vector<String>) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_with_key_values("CLIENT", "LIST", options))?;
return v.as_string();@briefProvides the system library operation `Conn.client_list`.
@detailsExecutes the `client_list` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.config_get
Signature
func config_get(self: net.redis.Conn, parameter: String) -> protocol.redis.RespValue, ErrCode func config_get(self: net.redis.Conn, parameter: String) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("CONFIG", "GET", parameter));
}@briefProvides the system library operation `Conn.config_get`.
@detailsExecutes the `config_get` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- parameterNamed parameter value consumed by the operation.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.config_resetstat
Signature
func config_resetstat(self: net.redis.Conn) -> ErrCode func config_resetstat(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("CONFIG", "RESETSTAT"));
if err != std.OK {@briefProvides the system library operation `Conn.config_resetstat`.
@detailsExecutes the `config_resetstat` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.config_rewrite
Signature
func config_rewrite(self: net.redis.Conn) -> ErrCode func config_rewrite(self: net.redis.Conn) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("CONFIG", "REWRITE"));
if err != std.OK {@briefProvides the system library operation `Conn.config_rewrite`.
@detailsExecutes the `config_rewrite` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.config_set
Signature
func config_set(self: net.redis.Conn, parameter: String, value: String) -> ErrCode func config_set(self: net.redis.Conn, parameter: String, value: String) -> ErrCode {
let v, err = self.command(protocol.redis.command_args("CONFIG", "SET", parameter, value));
if err != std.OK {@briefProvides the system library operation `Conn.config_set`.
@detailsExecutes the `config_set` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- parameterNamed parameter value consumed by the operation.
- valueValue to write or store.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.dbsize
Signature
func dbsize(self: net.redis.Conn) -> Int, ErrCode func dbsize(self: net.redis.Conn) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DBSIZE"))?;
return v.as_int();@briefProvides the system library operation `Conn.dbsize`.
@detailsExecutes the `dbsize` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.debug_object
Signature
func debug_object(self: net.redis.Conn, key: String) -> String, ErrCode func debug_object(self: net.redis.Conn, key: String) -> String, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("DEBUG", "OBJECT", key))?;
return v.as_string();@briefConfigures debug switches or debug output with `Conn.debug_object`.
@detailsExecutes the `debug_object` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.debug_segfault
Signature
func debug_segfault(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func debug_segfault(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("DEBUG", "SEGFAULT"));
}@briefConfigures debug switches or debug output with `Conn.debug_segfault`.
@detailsExecutes the `debug_segfault` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.flushall
Signature
func flushall(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode func flushall(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_values("FLUSHALL", options));
if err != std.OK {@briefProvides the system library operation `Conn.flushall`.
@detailsExecutes the `flushall` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.flushdb
Signature
func flushdb(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode func flushdb(self: net.redis.Conn, options: collections.Vector<String>) -> ErrCode {
let v, err = self.command(protocol.redis.command_with_values("FLUSHDB", options));
if err != std.OK {@briefProvides the system library operation `Conn.flushdb`.
@detailsExecutes the `flushdb` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.info
Signature
func info(self: net.redis.Conn, section: String = "") -> String, ErrCode func info(self: net.redis.Conn, section: String = "") -> String, ErrCode {
let v: protocol.redis.RespValue = new protocol.redis.RespValue();
if std.len(section) == 0 {@briefProvides the system library operation `Conn.info`.
@detailsExecutes the `info` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- sectionNamed section, segment, or record group processed by the operation.
@returnReturns `String, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.lastsave
Signature
func lastsave(self: net.redis.Conn) -> Int, ErrCode func lastsave(self: net.redis.Conn) -> Int, ErrCode {
let v: protocol.redis.RespValue = self.command(protocol.redis.command_args("LASTSAVE"))?;
return v.as_int();@briefProvides the system library operation `Conn.lastsave`.
@detailsExecutes the `lastsave` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `Int, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.monitor
Signature
func monitor(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func monitor(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("MONITOR"));
}@briefProvides the system library operation `Conn.monitor`.
@detailsExecutes the `monitor` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.psync
Signature
func psync(self: net.redis.Conn, replication_id: String, offset: String) -> protocol.redis.RespValue, ErrCode func psync(self: net.redis.Conn, replication_id: String, offset: String) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("PSYNC", replication_id, offset));
}@briefProvides the system library operation `Conn.psync`.
@detailsExecutes the `psync` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- replication_idReplication stream identifier used by server synchronization commands.
- offsetByte offset measured from the start position.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.save
Signature
func save(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func save(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("SAVE"));
}@briefProvides the system library operation `Conn.save`.
@detailsExecutes the `save` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.shutdown
Signature
func shutdown(self: net.redis.Conn, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func shutdown(self: net.redis.Conn, options: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("SHUTDOWN", options));
}@briefProvides the system library operation `Conn.shutdown`.
@detailsExecutes the `shutdown` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- optionsOperation-specific option string or option collection passed to the API.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.slaveof
Signature
func slaveof(self: net.redis.Conn, host: String, port: String) -> protocol.redis.RespValue, ErrCode func slaveof(self: net.redis.Conn, host: String, port: String) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("SLAVEOF", host, port));
}@briefProvides the system library operation `Conn.slaveof`.
@detailsExecutes the `slaveof` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- hostHost name or listen address.
- portPort number.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.slowlog
Signature
func slowlog(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func slowlog(self: net.redis.Conn, args_in: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_with_values("SLOWLOG", args_in));
}@briefProvides the system library operation `Conn.slowlog`.
@detailsExecutes the `slowlog` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- args_inInput argument list supplied to the native call or command encoder.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.sync
Signature
func sync(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func sync(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("SYNC"));
}@briefProvides the system library operation `Conn.sync`.
@detailsExecutes the `sync` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.time
Signature
func time(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode func time(self: net.redis.Conn) -> protocol.redis.RespValue, ErrCode {
return self.command(protocol.redis.command_args("TIME"));
}@briefProvides the system library operation `Conn.time`.
@detailsExecutes the `time` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Conn.pipeline
Signature
func pipeline(self: net.redis.Conn) -> net.redis.Pipeline func pipeline(self: net.redis.Conn) -> net.redis.Pipeline {
return new net.redis.Pipeline(self);
}@briefProvides the system library operation `Conn.pipeline`.
@detailsExecutes the `pipeline` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `net.redis.Pipeline`.
functionnet.redis::Conn.close
Signature
func close(self: net.redis.Conn) -> Void func close(self: net.redis.Conn) -> Void {
if self.closed {
return;@briefCloses resources and makes later operations unavailable with `Conn.close`.
@detailsExecutes the `close` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Conn.deinit
Signature
func deinit(self: net.redis.Conn) -> Void func deinit(self: net.redis.Conn) -> Void {
}
}@briefReleases fallback resources at the end of the `Conn` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Pipeline.init
Signature
func init(self: net.redis.Pipeline, conn: net.redis.Conn) -> Void func init(self: net.redis.Pipeline, conn: net.redis.Conn) -> Void {
self.conn = conn;
self.commands = new collections.Vector<collections.Vector<String> >();@briefInitializes a `Pipeline` instance.
@detailsEstablishes the initial field state for `Pipeline` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- connConnection object or native connection handle used for network I/O.
@returnVoid
functionnet.redis::Pipeline.add
Signature
func add(self: net.redis.Pipeline, args: collections.Vector<String>) -> Void func add(self: net.redis.Pipeline, args: collections.Vector<String>) -> Void {
_ = self.commands.push(args);
}@briefProvides the system library operation `Pipeline.add`.
@detailsExecutes the `add` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- argsArgument list forwarded to the command, process, callback, or formatter.
@returnVoid
functionnet.redis::Pipeline.exec
Signature
func exec(self: net.redis.Pipeline) -> net.redis.ResultList, ErrCode func exec(self: net.redis.Pipeline) -> net.redis.ResultList, ErrCode {
let wire: String = "";
loop (let command_index: Int = 0; command_index < self.commands.len(); command_index += 1) {@briefProvides the system library operation `Pipeline.exec`.
@detailsExecutes the `exec` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `net.redis.ResultList, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Pipeline.deinit
Signature
func deinit(self: net.redis.Pipeline) -> Void func deinit(self: net.redis.Pipeline) -> Void {
}
}@briefReleases fallback resources at the end of the `Pipeline` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Subscriber.init
Signature
func init(self: net.redis.Subscriber, conn: net.redis.Conn) -> Void func init(self: net.redis.Subscriber, conn: net.redis.Conn) -> Void {
self.conn = conn;
self.conn.in_pubsub = true;@briefInitializes a `Subscriber` instance.
@detailsEstablishes the initial field state for `Subscriber` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- connConnection object or native connection handle used for network I/O.
@returnVoid
functionnet.redis::Subscriber.subscribe
Signature
func subscribe(self: net.redis.Subscriber, channels: collections.Vector<String>) -> ErrCode func subscribe(self: net.redis.Subscriber, channels: collections.Vector<String>) -> ErrCode {
return self.subscribe_like("SUBSCRIBE", channels);
}@briefProvides the system library operation `Subscriber.subscribe`.
@detailsExecutes the `subscribe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- channelsCollection of channel names subscribed to or published through.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.psubscribe
Signature
func psubscribe(self: net.redis.Subscriber, patterns: collections.Vector<String>) -> ErrCode func psubscribe(self: net.redis.Subscriber, patterns: collections.Vector<String>) -> ErrCode {
return self.subscribe_like("PSUBSCRIBE", patterns);
}@briefProvides the system library operation `Subscriber.psubscribe`.
@detailsExecutes the `psubscribe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- patternsCollection of pattern strings used for matching or filtering.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.unsubscribe
Signature
func unsubscribe(self: net.redis.Subscriber, channels: collections.Vector<String>) -> ErrCode func unsubscribe(self: net.redis.Subscriber, channels: collections.Vector<String>) -> ErrCode {
return self.subscribe_like("UNSUBSCRIBE", channels);
}@briefProvides the system library operation `Subscriber.unsubscribe`.
@detailsExecutes the `unsubscribe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- channelsCollection of channel names subscribed to or published through.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.punsubscribe
Signature
func punsubscribe(self: net.redis.Subscriber, patterns: collections.Vector<String>) -> ErrCode func punsubscribe(self: net.redis.Subscriber, patterns: collections.Vector<String>) -> ErrCode {
return self.subscribe_like("PUNSUBSCRIBE", patterns);
}@briefProvides the system library operation `Subscriber.punsubscribe`.
@detailsExecutes the `punsubscribe` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- patternsCollection of pattern strings used for matching or filtering.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.subscribe_like
Signature
func subscribe_like(self: net.redis.Subscriber, command_name: String, names: collections.Vector<String>) -> ErrCode func subscribe_like(self: net.redis.Subscriber, command_name: String, names: collections.Vector<String>) -> ErrCode {
let args: collections.Vector<String> = new collections.Vector<String>();
_ = args.push(command_name);@briefProvides the system library operation `Subscriber.subscribe_like`.
@detailsExecutes the `subscribe_like` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- command_nameProtocol command name to encode, send, dispatch, or execute.
- namesCollection of names selected, encoded, looked up, or returned by the operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.receive
Signature
func receive(self: net.redis.Subscriber) -> net.redis.Message, ErrCode func receive(self: net.redis.Subscriber) -> net.redis.Message, ErrCode {
let raw: protocol.redis.RespValue = self.conn.read_value()?;
let msg: net.redis.Message = new net.redis.Message();@briefProvides the system library operation `Subscriber.receive`.
@detailsExecutes the `receive` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `net.redis.Message, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Subscriber.close
Signature
func close(self: net.redis.Subscriber) -> Void func close(self: net.redis.Subscriber) -> Void {
_ = self.conn.close();
}@briefCloses resources and makes later operations unavailable with `Subscriber.close`.
@detailsExecutes the `close` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Subscriber.deinit
Signature
func deinit(self: net.redis.Subscriber) -> Void func deinit(self: net.redis.Subscriber) -> Void {
}
}@briefReleases fallback resources at the end of the `Subscriber` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Pool.init
Signature
func init(self: net.redis.Pool, cfg: protocol.redis.Config, max_size: Int = 8) -> Void func init(self: net.redis.Pool, cfg: protocol.redis.Config, max_size: Int = 8) -> Void {
self.cfg = cfg;
self.max_size = max_size;@briefInitializes a `Pool` instance.
@detailsEstablishes the initial field state for `Pool` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- cfgConfiguration value or pointer used to initialize or control the operation.
- max_sizeMaximum allowed count or byte size.
@returnVoid
functionnet.redis::Pool.configure
Signature
func configure(self: net.redis.Pool, acquire_timeout_ms: Int = 15000, max_idle_ms: Int = 300000, max_lifetime_ms: Int = 1800000, validation_command: String = "PING", health_check_on_get: Bool = false, leak_threshold_ms: Int = 60000) -> Void func configure(self: net.redis.Pool, acquire_timeout_ms: Int = 15000, max_idle_ms: Int = 300000, max_lifetime_ms: Int = 1800000, validation_command: String = "PING", health_check_on_get: Bool = false, leak_threshold_ms: Int = 60000) -> Void {
self.acquire_timeout_ms = acquire_timeout_ms;
self.max_idle_ms = max_idle_ms;@briefProvides the system library operation `Pool.configure`.
@detailsExecutes the `configure` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- acquire_timeout_msTime interval or timeout value in milliseconds.
- max_idle_msMaximum allowed count or byte size.
- max_lifetime_msMaximum allowed count or byte size.
- validation_commandValue supplied by the caller for storage, comparison, or encoding.
- health_check_on_getWhether a health check is performed when borrowing a connection.
- leak_threshold_msTime interval or timeout value in milliseconds.
@returnVoid
functionnet.redis::Pool.should_discard
Signature
func should_discard(self: net.redis.Pool, conn: net.redis.Conn, now_ms: Int) -> Bool func should_discard(self: net.redis.Pool, conn: net.redis.Conn, now_ms: Int) -> Bool {
if conn.closed || conn.broken || self.max_lifetime_ms > 0 && conn.created_at_ms > 0 && now_ms - conn.created_at_ms >= self.max_lifetime_ms || self.max_idle_ms > 0 && conn.last_used_at_ms > 0 && now_ms - conn.last_used_at_ms >= self.max_idle_ms {
return true;@briefProvides the system library operation `Pool.should_discard`.
@detailsExecutes the `should_discard` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- connConnection object or native connection handle used for network I/O.
- now_msTime interval or timeout value in milliseconds.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionnet.redis::Pool.validate_conn
Signature
func validate_conn(self: net.redis.Pool, conn: net.redis.Conn) -> Bool func validate_conn(self: net.redis.Pool, conn: net.redis.Conn) -> Bool {
if conn.closed || conn.broken {
return false;@briefProvides the system library operation `Pool.validate_conn`.
@detailsExecutes the `validate_conn` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- connConnection object or native connection handle used for network I/O.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionnet.redis::Pool.mark_leak_if_needed
Signature
func mark_leak_if_needed(self: net.redis.Pool, now_ms: Int) -> Void func mark_leak_if_needed(self: net.redis.Pool, now_ms: Int) -> Void {
if self.leak_threshold_ms <= 0 || self.oldest_borrowed_at_ms <= 0 {
return;@briefProvides the system library operation `Pool.mark_leak_if_needed`.
@detailsExecutes the `mark_leak_if_needed` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- now_msTime interval or timeout value in milliseconds.
@returnVoid
functionnet.redis::Pool.get_timeout
Signature
func get_timeout(self: net.redis.Pool, timeout_ms: Int) -> net.redis.Conn, ErrCode func get_timeout(self: net.redis.Pool, timeout_ms: Int) -> net.redis.Conn, ErrCode {
let deadline: Int = 0;
if timeout_ms > 0 {@briefReads the state or data for `Pool.get_timeout`.
@detailsExecutes the `get_timeout` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- timeout_msTimeout in milliseconds; negative values usually select blocking or default timeout behavior.
@returnReturns `net.redis.Conn, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Pool.get
Signature
func get(self: net.redis.Pool) -> net.redis.Conn, ErrCode func get(self: net.redis.Pool) -> net.redis.Conn, ErrCode {
return self.get_timeout(self.acquire_timeout_ms);
}@briefReads the element for `Pool.get`.
@detailsExecutes the `get` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `net.redis.Conn, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::Pool.put
Signature
func put(self: net.redis.Pool, conn: net.redis.Conn) -> Void func put(self: net.redis.Pool, conn: net.redis.Conn) -> Void {
let now_ms: Int = time.now_ms();
conn.last_used_at_ms = now_ms;@briefProvides the system library operation `Pool.put`.
@detailsExecutes the `put` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- connConnection object or native connection handle used for network I/O.
@returnVoid
functionnet.redis::Pool.active_count
Signature
func active_count(self: net.redis.Pool) -> Int func active_count(self: net.redis.Pool) -> Int {
_ = self.mu.lock();
let n: Int = self.in_use;@briefProvides the system library operation `Pool.active_count`.
@detailsExecutes the `active_count` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionnet.redis::Pool.idle_count
Signature
func idle_count(self: net.redis.Pool) -> Int func idle_count(self: net.redis.Pool) -> Int {
_ = self.mu.lock();
let n: Int = self.idle.len();@briefProvides the system library operation `Pool.idle_count`.
@detailsExecutes the `idle_count` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionnet.redis::Pool.suspected_leaks
Signature
func suspected_leaks(self: net.redis.Pool) -> Int func suspected_leaks(self: net.redis.Pool) -> Int {
_ = self.mu.lock();
let n: Int = self.leak_reports;@briefProvides the system library operation `Pool.suspected_leaks`.
@detailsExecutes the `suspected_leaks` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns the operation result as `Int`.
functionnet.redis::Pool.close
Signature
func close(self: net.redis.Pool) -> Void func close(self: net.redis.Pool) -> Void {
_ = self.mu.lock();
self.closed = true;@briefCloses resources and makes later operations unavailable with `Pool.close`.
@detailsExecutes the `close` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::Pool.deinit
Signature
func deinit(self: net.redis.Pool) -> Void func deinit(self: net.redis.Pool) -> Void {
}
}@briefReleases fallback resources at the end of the `Pool` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::SlotRange.init
Signature
func init(self: net.redis.SlotRange, start_slot: Int = 0, end_slot: Int = 0, host: String = "", port: Int = 6379) -> Void func init(self: net.redis.SlotRange, start_slot: Int = 0, end_slot: Int = 0, host: String = "", port: Int = 6379) -> Void {
self.start_slot = start_slot;
self.end_slot = end_slot;@briefInitializes a `SlotRange` instance.
@detailsEstablishes the initial field state for `SlotRange` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- start_slotFirst hash slot included in the requested slot range.
- end_slotLast hash slot included in the requested slot range.
- hostHost name or listen address.
- portPort number.
@returnVoid
functionnet.redis::SlotRange.contains
Signature
func contains(self: net.redis.SlotRange, slot: Int) -> Bool func contains(self: net.redis.SlotRange, slot: Int) -> Bool {
return slot >= self.start_slot && slot <= self.end_slot;
}@briefProvides the system library operation `SlotRange.contains`.
@detailsExecutes the `contains` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- slotHash slot or storage slot selected by the operation.
@returnReturns a boolean result; true means the condition holds or the operation succeeded.
functionnet.redis::SlotRange.deinit
Signature
func deinit(self: net.redis.SlotRange) -> Void func deinit(self: net.redis.SlotRange) -> Void {
}
}@briefReleases fallback resources at the end of the `SlotRange` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::ClusterClient.init
Signature
func init(self: net.redis.ClusterClient, cfg: protocol.redis.Config) -> Void func init(self: net.redis.ClusterClient, cfg: protocol.redis.Config) -> Void {
self.cfg = cfg;
self.slots = new collections.Vector<net.redis.SlotRange>();@briefInitializes a `ClusterClient` instance.
@detailsEstablishes the initial field state for `ClusterClient` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- cfgConfiguration value or pointer used to initialize or control the operation.
@returnVoid
functionnet.redis::ClusterClient.node_for_slot
Signature
func node_for_slot(self: net.redis.ClusterClient, slot: Int) -> net.redis.SlotRange func node_for_slot(self: net.redis.ClusterClient, slot: Int) -> net.redis.SlotRange {
loop (let i: Int = 0; i < self.slots.len(); i += 1) {
let r: net.redis.SlotRange = self.slots.get_unchecked(i);@briefProvides the system library operation `ClusterClient.node_for_slot`.
@detailsExecutes the `node_for_slot` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- slotHash slot or storage slot selected by the operation.
@returnReturns the operation result as `net.redis.SlotRange`.
functionnet.redis::ClusterClient.command_for_key
Signature
func command_for_key(self: net.redis.ClusterClient, key: String, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode func command_for_key(self: net.redis.ClusterClient, key: String, args: collections.Vector<String>) -> protocol.redis.RespValue, ErrCode {
let slot: Int = protocol.redis.key_slot(key);
loop (let attempt: Int = 0; attempt <= self.max_redirects; attempt += 1) {@briefProvides the system library operation `ClusterClient.command_for_key`.
@detailsExecutes the `command_for_key` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- keyKey name.
- argsArgument list forwarded to the command, process, callback, or formatter.
@returnReturns `protocol.redis.RespValue, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::ClusterClient.deinit
Signature
func deinit(self: net.redis.ClusterClient) -> Void func deinit(self: net.redis.ClusterClient) -> Void {
}
}@briefReleases fallback resources at the end of the `ClusterClient` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::SentinelConfig.init
Signature
func init(self: net.redis.SentinelConfig) -> Void func init(self: net.redis.SentinelConfig) -> Void {
self.sentinels = new collections.Vector<String>();
self.master_name = "mymaster";@briefInitializes a `SentinelConfig` instance.
@detailsEstablishes the initial field state for `SentinelConfig` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::SentinelConfig.deinit
Signature
func deinit(self: net.redis.SentinelConfig) -> Void func deinit(self: net.redis.SentinelConfig) -> Void {
}
}@briefReleases fallback resources at the end of the `SentinelConfig` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::SentinelClient.init
Signature
func init(self: net.redis.SentinelClient, cfg: net.redis.SentinelConfig) -> Void func init(self: net.redis.SentinelClient, cfg: net.redis.SentinelConfig) -> Void {
self.cfg = cfg;
}@briefInitializes a `SentinelClient` instance.
@detailsEstablishes the initial field state for `SentinelClient` so other methods can be called safely. Constructor logic should keep fields consistent and avoid leaking partially initialized resources.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
- cfgConfiguration value or pointer used to initialize or control the operation.
@returnVoid
functionnet.redis::SentinelClient.discover_master
Signature
func discover_master(self: net.redis.SentinelClient) -> protocol.redis.Config, ErrCode func discover_master(self: net.redis.SentinelClient) -> protocol.redis.Config, ErrCode {
loop (let i: Int = 0; i < self.cfg.sentinels.len(); i += 1) {
let endpoint: String = self.cfg.sentinels.get_unchecked(i);@briefProvides the system library operation `SentinelClient.discover_master`.
@detailsExecutes the `discover_master` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnReturns `protocol.redis.Config, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::SentinelClient.deinit
Signature
func deinit(self: net.redis.SentinelClient) -> Void func deinit(self: net.redis.SentinelClient) -> Void {
}
}@briefReleases fallback resources at the end of the `SentinelClient` lifetime.
@detailsThis destructor hook is called by object lifetime management to clean up underlying resources that were not released explicitly. Normal application code should prefer `dispose`, `close`, or the module-specific close function to release resources at a deterministic time.
@param
- selfThe current instance whose fields, handles, buffers, or external resources are read or modified by this method.
@returnVoid
functionnet.redis::connect
Signature
func connect(cfg: protocol.redis.Config) -> net.redis.Conn, ErrCodefunc connect(cfg: protocol.redis.Config) -> net.redis.Conn, ErrCode {
let fd: Int = net.tcp.connect(cfg.host, cfg.port, cfg.timeout_ms)?;
let conn: net.redis.Conn = new net.redis.Conn(fd, cfg.timeout_ms);@briefEstablishes a connection with `connect`.
@detailsExecutes the `connect` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- cfgConfiguration value or pointer used to initialize or control the operation.
@returnReturns `net.redis.Conn, ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
functionnet.redis::initialize_connection
Signature
func initialize_connection(conn: net.redis.Conn, cfg: protocol.redis.Config) -> ErrCodefunc initialize_connection(conn: net.redis.Conn, cfg: protocol.redis.Config) -> ErrCode {
if cfg.protocol_version >= 3 {
let hello_args: collections.Vector<String> = new collections.Vector<String>();@briefProvides the system library operation `initialize_connection`.
@detailsExecutes the `initialize_connection` system-library API. The documented parameters define the accepted inputs, ownership requirements, range limits, and timeout behavior for this call. Callers must check returned `ErrCode` values or boolean status values before using the result.
@param
- connConnection object or native connection handle used for network I/O.
- cfgConfiguration value or pointer used to initialize or control the operation.
@returnReturns `ErrCode`; on success the error code is `std.OK` or `OK`, and on failure the error code describes the failure while any returned value contains the usable partial result when available.
Variables
Class fields (var).
varnet.redis::Message.kind
Type
String@brief`kind` field.
@detailsHolds the `kind` value for each `Message` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var kind: String;
/*
@brief `channel` field.varnet.redis::Message.channel
Type
String@brief`channel` field.
@detailsHolds the `channel` value for each `Message` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var channel: String;
/*
@brief `pattern` field.varnet.redis::Message.pattern
Type
String@brief`pattern` field.
@detailsHolds the `pattern` value for each `Message` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var pattern: String;
/*
@brief `payload` field.varnet.redis::Message.payload
Type
String@brief`payload` field.
@detailsHolds the `payload` value for each `Message` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var payload: String;
/*
@brief `raw` field.varnet.redis::Message.raw
Type
protocol.redis.RespValue@brief`raw` field.
@detailsHolds the `raw` value for each `Message` instance. The field type is `protocol.redis.RespValue`, and constructors and methods keep it synchronized with the object's runtime state.
var raw: protocol.redis.RespValue;
/*varnet.redis::ResultList.values
Type
collections.Vector<protocol.redis.RespValue>@brief`values` field.
@detailsHolds the `values` value for each `ResultList` instance. The field type is `collections.Vector<protocol.redis.RespValue>`, and constructors and methods keep it synchronized with the object's runtime state.
var values: collections.Vector<protocol.redis.RespValue>;
/*varnet.redis::Conn.fd
Type
Int@brief`fd` field.
@detailsStores the underlying file descriptor or socket descriptor. The field type is `Int`, and it is maintained by the constructors and methods of `Conn`.
var fd: Int;
/*
@brief `tls_h` field.varnet.redis::Conn.tls_h
Type
Int@brief`tls_h` field.
@detailsHolds the `tls_h` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var tls_h: Int;
/*
@brief `tls_enabled` field.varnet.redis::Conn.tls_enabled
Type
Bool@brief`tls_enabled` field.
@detailsHolds the `tls_enabled` value for each `Conn` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
var tls_enabled: Bool;
/*
@brief `timeout_ms` field.varnet.redis::Conn.timeout_ms
Type
Int@brief`timeout_ms` field.
@detailsStores the default timeout in milliseconds. The field type is `Int`, and it is maintained by the constructors and methods of `Conn`.
var timeout_ms: Int;
/*
@brief `read_timeout_ms` field.varnet.redis::Conn.read_timeout_ms
Type
Int@brief`read_timeout_ms` field.
@detailsHolds the `read_timeout_ms` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var read_timeout_ms: Int;
/*
@brief `write_timeout_ms` field.varnet.redis::Conn.write_timeout_ms
Type
Int@brief`write_timeout_ms` field.
@detailsHolds the `write_timeout_ms` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var write_timeout_ms: Int;
/*
@brief `closed` field.varnet.redis::Conn.closed
Type
Bool@brief`closed` field.
@detailsIndicates whether the resource has already been closed. The field type is `Bool`, and it is maintained by the constructors and methods of `Conn`.
var closed: Bool;
/*
@brief `broken` field.varnet.redis::Conn.broken
Type
Bool@brief`broken` field.
@detailsHolds the `broken` value for each `Conn` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
var broken: Bool;
/*
@brief `in_pubsub` field.varnet.redis::Conn.in_pubsub
Type
Bool@brief`in_pubsub` field.
@detailsHolds the `in_pubsub` value for each `Conn` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
var in_pubsub: Bool;
/*
@brief `reader` field.varnet.redis::Conn.reader
Type
protocol.redis.Reader@brief`reader` field.
@detailsHolds the `reader` value for each `Conn` instance. The field type is `protocol.redis.Reader`, and constructors and methods keep it synchronized with the object's runtime state.
var reader: protocol.redis.Reader;
/*
@brief `last_error` field.varnet.redis::Conn.last_error
Type
protocol.redis.RedisError@brief`last_error` field.
@detailsHolds the `last_error` value for each `Conn` instance. The field type is `protocol.redis.RedisError`, and constructors and methods keep it synchronized with the object's runtime state.
var last_error: protocol.redis.RedisError;
/*
@brief `created_at_ms` field.varnet.redis::Conn.created_at_ms
Type
Int@brief`created_at_ms` field.
@detailsHolds the `created_at_ms` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var created_at_ms: Int;
/*
@brief `last_used_at_ms` field.varnet.redis::Conn.last_used_at_ms
Type
Int@brief`last_used_at_ms` field.
@detailsHolds the `last_used_at_ms` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var last_used_at_ms: Int;
/*
@brief `borrowed_at_ms` field.varnet.redis::Conn.borrowed_at_ms
Type
Int@brief`borrowed_at_ms` field.
@detailsHolds the `borrowed_at_ms` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var borrowed_at_ms: Int;
/*
@brief `use_count` field.varnet.redis::Conn.use_count
Type
Int@brief`use_count` field.
@detailsHolds the `use_count` value for each `Conn` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var use_count: Int;
/*varnet.redis::Pipeline.conn
Type
net.redis.Conn@brief`conn` field.
@detailsHolds the `conn` value for each `Pipeline` instance. The field type is `net.redis.Conn`, and constructors and methods keep it synchronized with the object's runtime state.
var conn: net.redis.Conn;
/*
@brief `commands` field.varnet.redis::Pipeline.commands
Type
collections.Vector<collections.Vector<String> >@brief`commands` field.
@detailsHolds the `commands` value for each `Pipeline` instance. The field type is `collections.Vector<collections.Vector<String> >`, and constructors and methods keep it synchronized with the object's runtime state.
var commands: collections.Vector<collections.Vector<String> >;
/*varnet.redis::Subscriber.conn
Type
net.redis.Conn@brief`conn` field.
@detailsHolds the `conn` value for each `Subscriber` instance. The field type is `net.redis.Conn`, and constructors and methods keep it synchronized with the object's runtime state.
var conn: net.redis.Conn;
/*
@brief `commands` field.varnet.redis::Pool.cfg
Type
protocol.redis.Config@brief`cfg` field.
@detailsHolds the `cfg` value for each `Pool` instance. The field type is `protocol.redis.Config`, and constructors and methods keep it synchronized with the object's runtime state.
var cfg: protocol.redis.Config;
/*
@brief `max_size` field.varnet.redis::Pool.max_size
Type
Int@brief`max_size` field.
@detailsHolds the `max_size` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var max_size: Int;
/*
@brief `idle` field.varnet.redis::Pool.idle
Type
collections.Vector<net.redis.Conn>@brief`idle` field.
@detailsHolds the `idle` value for each `Pool` instance. The field type is `collections.Vector<net.redis.Conn>`, and constructors and methods keep it synchronized with the object's runtime state.
var idle: collections.Vector<net.redis.Conn>;
/*
@brief `mu` field.varnet.redis::Pool.mu
Type
sync.Mutex@brief`mu` field.
@detailsHolds the `mu` value for each `Pool` instance. The field type is `sync.Mutex`, and constructors and methods keep it synchronized with the object's runtime state.
var mu: sync.Mutex;
/*
@brief `total` field.varnet.redis::Pool.total
Type
Int@brief`total` field.
@detailsHolds the `total` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var total: Int;
/*
@brief `in_use` field.varnet.redis::Pool.in_use
Type
Int@brief`in_use` field.
@detailsHolds the `in_use` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var in_use: Int;
/*
@brief `waiters` field.varnet.redis::Pool.waiters
Type
Int@brief`waiters` field.
@detailsHolds the `waiters` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var waiters: Int;
/*
@brief `closed` field.varnet.redis::Pool.closed
Type
Bool@brief`closed` field.
@detailsIndicates whether the resource has already been closed. The field type is `Bool`, and it is maintained by the constructors and methods of `Pool`.
var closed: Bool;
/*
@brief `broken` field.varnet.redis::Pool.acquire_timeout_ms
Type
Int@brief`acquire_timeout_ms` field.
@detailsHolds the `acquire_timeout_ms` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var acquire_timeout_ms: Int;
/*
@brief `max_idle_ms` field.varnet.redis::Pool.max_idle_ms
Type
Int@brief`max_idle_ms` field.
@detailsHolds the `max_idle_ms` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var max_idle_ms: Int;
/*
@brief `max_lifetime_ms` field.varnet.redis::Pool.max_lifetime_ms
Type
Int@brief`max_lifetime_ms` field.
@detailsHolds the `max_lifetime_ms` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var max_lifetime_ms: Int;
/*
@brief `validation_command` field.varnet.redis::Pool.validation_command
Type
String@brief`validation_command` field.
@detailsHolds the `validation_command` value for each `Pool` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var validation_command: String;
/*
@brief `health_check_on_get` field.varnet.redis::Pool.health_check_on_get
Type
Bool@brief`health_check_on_get` field.
@detailsHolds the `health_check_on_get` value for each `Pool` instance. The field type is `Bool`, and constructors and methods keep it synchronized with the object's runtime state.
var health_check_on_get: Bool;
/*
@brief `leak_threshold_ms` field.varnet.redis::Pool.leak_threshold_ms
Type
Int@brief`leak_threshold_ms` field.
@detailsHolds the `leak_threshold_ms` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var leak_threshold_ms: Int;
/*
@brief `leak_reports` field.varnet.redis::Pool.leak_reports
Type
Int@brief`leak_reports` field.
@detailsHolds the `leak_reports` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var leak_reports: Int;
/*
@brief `oldest_borrowed_at_ms` field.varnet.redis::Pool.oldest_borrowed_at_ms
Type
Int@brief`oldest_borrowed_at_ms` field.
@detailsHolds the `oldest_borrowed_at_ms` value for each `Pool` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var oldest_borrowed_at_ms: Int;
/*varnet.redis::SlotRange.start_slot
Type
Int@brief`start_slot` field.
@detailsHolds the `start_slot` value for each `SlotRange` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var start_slot: Int;
/*
@brief `end_slot` field.varnet.redis::SlotRange.end_slot
Type
Int@brief`end_slot` field.
@detailsHolds the `end_slot` value for each `SlotRange` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var end_slot: Int;
/*
@brief `host` field.varnet.redis::SlotRange.host
Type
String@brief`host` field.
@detailsStores a host name or network address. The field type is `String`, and it is maintained by the constructors and methods of `SlotRange`.
var host: String;
/*
@brief `port` field.varnet.redis::SlotRange.port
Type
Int@brief`port` field.
@detailsStores a port number. The field type is `Int`, and it is maintained by the constructors and methods of `SlotRange`.
var port: Int;
/*varnet.redis::ClusterClient.cfg
Type
protocol.redis.Config@brief`cfg` field.
@detailsHolds the `cfg` value for each `ClusterClient` instance. The field type is `protocol.redis.Config`, and constructors and methods keep it synchronized with the object's runtime state.
var cfg: protocol.redis.Config;
/*
@brief `max_size` field.varnet.redis::ClusterClient.slots
Type
collections.Vector<net.redis.SlotRange>@brief`slots` field.
@detailsHolds the `slots` value for each `ClusterClient` instance. The field type is `collections.Vector<net.redis.SlotRange>`, and constructors and methods keep it synchronized with the object's runtime state.
var slots: collections.Vector<net.redis.SlotRange>;
/*
@brief `max_redirects` field.varnet.redis::ClusterClient.max_redirects
Type
Int@brief`max_redirects` field.
@detailsHolds the `max_redirects` value for each `ClusterClient` instance. The field type is `Int`, and constructors and methods keep it synchronized with the object's runtime state.
var max_redirects: Int;
/*varnet.redis::SentinelConfig.sentinels
Type
collections.Vector<String>@brief`sentinels` field.
@detailsHolds the `sentinels` value for each `SentinelConfig` instance. The field type is `collections.Vector<String>`, and constructors and methods keep it synchronized with the object's runtime state.
var sentinels: collections.Vector<String>;
/*
@brief `master_name` field.varnet.redis::SentinelConfig.master_name
Type
String@brief`master_name` field.
@detailsHolds the `master_name` value for each `SentinelConfig` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var master_name: String;
/*
@brief `username` field.varnet.redis::SentinelConfig.username
Type
String@brief`username` field.
@detailsHolds the `username` value for each `SentinelConfig` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var username: String;
/*
@brief `password` field.varnet.redis::SentinelConfig.password
Type
String@brief`password` field.
@detailsHolds the `password` value for each `SentinelConfig` instance. The field type is `String`, and constructors and methods keep it synchronized with the object's runtime state.
var password: String;
/*
@brief `timeout_ms` field.varnet.redis::SentinelConfig.timeout_ms
Type
Int@brief`timeout_ms` field.
@detailsStores the default timeout in milliseconds. The field type is `Int`, and it is maintained by the constructors and methods of `SentinelConfig`.
var timeout_ms: Int;
/*
@brief `read_timeout_ms` field.varnet.redis::SentinelClient.cfg
Type
net.redis.SentinelConfig@brief`cfg` field.
@detailsHolds the `cfg` value for each `SentinelClient` instance. The field type is `net.redis.SentinelConfig`, and constructors and methods keep it synchronized with the object's runtime state.
var cfg: protocol.redis.Config;
/*
@brief `max_size` field.