vrl 0.32.0

Vector Remap Language
Documentation 
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

{
  "anchor": "chunks",
  "name": "chunks",
  "category": "Array",
  "description": "Chunks `value` into slices of length `chunk_size` bytes.",
  "arguments": [
    {
      "name": "value",
      "description": "The array of bytes to split.",
      "required": true,
      "type": [
        "string"
      ]
    },
    {
      "name": "chunk_size",
      "description": "The desired length of each chunk in bytes. This may be constrained by the host platform architecture.",
      "required": true,
      "type": [
        "integer"
      ]
    }
  ],
  "return": {
    "types": [
      "array"
    ],
    "rules": [
      "`chunks` is considered fallible if the supplied `chunk_size` is an expression, and infallible if it's a literal integer."
    ]
  },
  "internal_failure_reasons": [
    "`chunk_size` must be at least 1 byte.",
    "`chunk_size` is too large."
  ],
  "examples": [
    {
      "title": "Split a string into chunks",
      "source": "chunks(\"abcdefgh\", 4)",
      "return": [
        "abcd",
        "efgh"
      ]
    },
    {
      "title": "Chunks do not respect unicode code point boundaries",
      "source": "chunks(\"ab你好\", 4)",
      "return": [
        "ab�",
        "�好"
      ]
    }
  ],
  "pure": true
}