src/commands/bitfield.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

{
    "BITFIELD": {
        "summary": "Performs arbitrary bitfield integer operations on strings.",
        "complexity": "O(1) for each subcommand specified",
        "group": "bitmap",
        "since": "3.2.0",
        "arity": -2,
        "function": "bitfieldCommand",
        "get_keys_function": "bitfieldGetKeys",
        "command_flags": [
            "WRITE",
            "DENYOOM"
        ],
        "acl_categories": [
            "BITMAP"
        ],
        "key_specs": [
            {
                "notes": "This command allows both access and modification of the key",
                "flags": [
                    "RW",
                    "UPDATE",
                    "ACCESS",
                    "VARIABLE_FLAGS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "operation",
                "type": "oneof",
                "multiple": true,
                "optional": true,
                "arguments": [
                    {
                        "token": "GET",
                        "name": "get-block",
                        "type": "block",
                        "arguments": [
                            {
                                "name": "encoding",
                                "type": "string"
                            },
                            {
                                "name": "offset",
                                "type": "integer"
                            }
                        ]
                    },
                    {
                        "name": "write",
                        "type": "block",
                        "arguments": [
                            {
                                "token": "OVERFLOW",
                                "name": "overflow-block",
                                "type": "oneof",
                                "optional": true,
                                "arguments": [
                                    {
                                        "name": "wrap",
                                        "type": "pure-token",
                                        "token": "WRAP"
                                    },
                                    {
                                        "name": "sat",
                                        "type": "pure-token",
                                        "token": "SAT"
                                    },
                                    {
                                        "name": "fail",
                                        "type": "pure-token",
                                        "token": "FAIL"
                                    }
                                ]
                            },
                            {
                                "name": "write-operation",
                                "type": "oneof",
                                "arguments": [
                                    {
                                        "token": "SET",
                                        "name": "set-block",
                                        "type": "block",
                                        "arguments": [
                                            {
                                                "name": "encoding",
                                                "type": "string"
                                            },
                                            {
                                                "name": "offset",
                                                "type": "integer"
                                            },
                                            {
                                                "name": "value",
                                                "type": "integer"
                                            }
                                        ]
                                    },
                                    {
                                        "token": "INCRBY",
                                        "name": "incrby-block",
                                        "type": "block",
                                        "arguments": [
                                            {
                                                "name": "encoding",
                                                "type": "string"
                                            },
                                            {
                                                "name": "offset",
                                                "type": "integer"
                                            },
                                            {
                                                "name": "increment",
                                                "type": "integer"
                                            }
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        ],
        "reply_schema": {
            "type": "array",
            "items": {
                "oneOf": [
                    {
                        "description": "The result of the subcommand at the same position",
                        "type": "integer"
                    },
                    {
                        "description": "In case OVERFLOW FAIL was given and overflows or underflows detected",
                        "type": "null"
                    }
                ]
            }
        }
    }
}