radish

All timeouts are in milliseconds

Types

ExpireCondition

pub type ExpireCondition {
  NX
  XX
  GT
  LT
}

Constructors

```
NX
```
```
XX
```
```
GT
```
```
LT
```

KeyType

</>

pub type KeyType {
  Set
  List
  ZSet
  Hash
  String
  Stream
}

Constructors

```
Set
```
```
List
```
```
ZSet
```
```
Hash
```
```
String
```
```
Stream
```

Message

</>

pub type Message =
  client.Message

</>

pub type Next {
  Continue
  UnsubscribeFromAll
  UnsubscribeFrom(List(String))
}

Constructors

```
Continue
```
```
UnsubscribeFromAll
```
```
UnsubscribeFrom(List(String))
```

StartOption

</>

pub type StartOption {
  Timeout(Int)
  Auth(String)
  AuthWithUsername(String, String)
}

Constructors

```
Timeout(Int)
```
```
Auth(String)
```
```
AuthWithUsername(String, String)
```

Functions

append

</>

pub fn append(
  client: Subject(Message),
  key: String,
  value: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

decr

</>

pub fn decr(
  client: Subject(Message),
  key: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

decr_by

</>

pub fn decr_by(
  client: Subject(Message),
  key: String,
  value: Int,
  timeout: Int,
) -> Result(Int, Error)

see here!

del

</>

pub fn del(
  client: Subject(Message),
  keys: List(String),
  timeout: Int,
) -> Result(Int, Error)

see here!

exists

</>

pub fn exists(
  client: Subject(Message),
  keys: List(String),
  timeout: Int,
) -> Result(Int, Error)

see here!

expire

</>

pub fn expire(
  client: Subject(Message),
  key: String,
  ttl: Int,
  timeout: Int,
) -> Result(Int, Error)

see here!

expire_if

</>

pub fn expire_if(
  client: Subject(Message),
  key: String,
  ttl: Int,
  condition: ExpireCondition,
  timeout: Int,
) -> Result(Int, Error)

see here!

get

</>

pub fn get(
  client: Subject(Message),
  key: String,
  timeout: Int,
) -> Result(String, Error)

see here!

incr

</>

pub fn incr(
  client: Subject(Message),
  key: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

incr_by

</>

pub fn incr_by(
  client: Subject(Message),
  key: String,
  value: Int,
  timeout: Int,
) -> Result(Int, Error)

see here!

incr_by_float

</>

pub fn incr_by_float(
  client: Subject(Message),
  key: String,
  value: Float,
  timeout: Int,
) -> Result(Float, Error)

see here!

key_type

</>

pub fn key_type(
  client: Subject(Message),
  key: String,
  timeout: Int,
) -> Result(KeyType, Error)

see here!

keys

</>

pub fn keys(
  client: Subject(Message),
  pattern: String,
  timeout: Int,
) -> Result(List(String), Error)

see here!

mget

</>

pub fn mget(
  client: Subject(Message),
  keys: List(String),
  timeout: Int,
) -> Result(List(String), Error)

see here!

mset

</>

pub fn mset(
  client: Subject(Message),
  kv_list: List(#(String, String)),
  timeout: Int,
) -> Result(String, Error)

see here!

persist

</>

pub fn persist(
  client: Subject(Message),
  key: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

ping

</>

pub fn ping(
  client: Subject(Message),
  timeout: Int,
) -> Result(String, Error)

see here! for use with a custom message, use ping_message/3.

ping_message

</>

pub fn ping_message(
  client: Subject(Message),
  message: String,
  timeout: Int,
) -> Result(String, Error)

see here!

publish

</>

pub fn publish(
  client: Subject(Message),
  channel: String,
  message: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

random_key

</>

pub fn random_key(
  client: Subject(Message),
  timeout: Int,
) -> Result(String, Error)

see here!

rename

</>

pub fn rename(
  client: Subject(Message),
  key: String,
  new_key: String,
  timeout: Int,
) -> Result(String, Error)

see here!

renamenx

</>

pub fn renamenx(
  client: Subject(Message),
  key: String,
  new_key: String,
  timeout: Int,
) -> Result(Int, Error)

see here!

scan

</>

pub fn scan(
  client: Subject(Message),
  cursor: Int,
  count: Int,
  timeout: Int,
) -> Result(#(List(String), Int), Error)

see here!

scan_pattern

</>

pub fn scan_pattern(
  client: Subject(Message),
  cursor: Int,
  pattern: String,
  count: Int,
  timeout: Int,
) -> Result(#(List(String), Int), Error)

see here!

scan_pattern_with_type

</>

pub fn scan_pattern_with_type(
  client: Subject(Message),
  cursor: Int,
  key_type: KeyType,
  pattern: String,
  count: Int,
  timeout: Int,
) -> Result(#(List(String), Int), Error)

see here!

scan_with_type

</>

pub fn scan_with_type(
  client: Subject(Message),
  cursor: Int,
  key_type: KeyType,
  count: Int,
  timeout: Int,
) -> Result(#(List(String), Int), Error)

see here!

set

</>

pub fn set(
  client: Subject(Message),
  key: String,
  value: String,
  timeout: Int,
) -> Result(String, Error)

see here!

set_existing

</>

pub fn set_existing(
  client: Subject(Message),
  key: String,
  value: String,
  timeout: Int,
) -> Result(String, Error)

see here!

set_new

</>

pub fn set_new(
  client: Subject(Message),
  key: String,
  value: String,
  timeout: Int,
) -> Result(String, Error)

see here!

shutdown

</>

pub fn shutdown(client: Subject(Message)) -> Nil

start

</>

pub fn start(
  host: String,
  port: Int,
  options: List(StartOption),
) -> Result(Subject(Message), StartError)

</>

pub fn subscribe(
  client: Subject(Message),
  channels: List(String),
  init_handler: fn(String, Int) -> Nil,
  message_handler: fn(String, String) -> Next,
  timeout: Int,
) -> Nil

see here! Also see here!

subscribe_to_patterns

</>

pub fn subscribe_to_patterns(
  client: Subject(Message),
  patterns: List(String),
  init_handler: fn(String, Int) -> Nil,
  message_handler: fn(String, String, String) -> Next,
  timeout: Int,
) -> Nil

see here! Also see here!