resynth 0.5.0

A packet synthesis 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
56
57
58
59
60
61
62
63
64
65
66
67
68

 # Buffers and File I/O

 Buffered I/O — read from and write to byte buffers and files.
## Index


### Classes

| Class | Description |
| ----- | ----------- |
| [BufIO](BufIO.md) | Buffered I/O |

### Functions

| Function | Returns | Description |
| -------- | ------- | ----------- |
| [bufio](#bufio) | [BufIO](../io/BufIO.md) | Create a `BufIO` buffer from one or more byte strings, from which bytes can be consumed in sequential chunks using `read(n)` and `read_all()`. This is useful for splitting a pre-assembled payload across multiple packets — for example, sending the first 15 bytes of a TLS record in one TCP segment and the rest in another. |
| [file](#file) | `bytes` | Load the contents of a file into a string |



## bufio
```resynth
resynth fn bufio (
    =>
    *collect_args: bytes,
) -> BufIO;
```
Create a `BufIO` buffer from one or more byte strings, from which bytes
 can be consumed in sequential chunks using `read(n)` and `read_all()`.
 This is useful for splitting a pre-assembled payload across multiple
 packets — for example, sending the first 15 bytes of a TLS record in one
 TCP segment and the rest in another.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| [BufIO](../io/BufIO.md) |

## file
```resynth
resynth fn file (
    filename: bytes,
    =>
    *collect_args: bytes,
) -> bytes;
```
Load the contents of a file into a string

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `filename` | `bytes` | Path to the file to load |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `bytes` |