resynth 0.6.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
69
70
71
72
73
74
75
76
77
78

 # Ethernet

 Ethernet frame construction and ethertype constants.
## Index


### Modules

| Module | Description |
| ------ | ----------- |
| [ethertype](ethertype/README.md) | Ethernet Ethertypes |

### Functions

| Function | Returns | Description |
| -------- | ------- | ----------- |
| [frame](#frame) | `Pkt` | Construct an Ethernet frame |
| [from_ip](#from_ip) | `bytes` | Map an IPv4 address to a locally-administered Ethernet address |

### Constants

| Name | Value |
| ---- | ----- |
| BROADCAST | `(bytes)"\xff\xff\xff\xff\xff\xff"` |



## frame
```resynth
resynth fn frame (
    src: bytes,
    dst: bytes,
    ethertype: u16 = 0x0800,
    =>
    *collect_args: bytes,
) -> Pkt;
```
Construct an Ethernet frame

 Wraps the payload bytes in an Ethernet II frame header.

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `src` | `bytes` | Source ethernet address as 6 bytes |
| `dst` | `bytes` | Destination ethernet address as 6 bytes |
| `ethertype` | `u16` | [EtherType](ethertype/README.md) identifying the encapsulated protocol _(default: `0x0800`)_ |
| `…` | `bytes` | Zero or more additional values |

### Returns

| Type |
| ---- |
| `Pkt` |

## from_ip
```resynth
resynth fn from_ip (
    ip: Ip4,
) -> bytes;
```
Map an IPv4 address to a locally-administered Ethernet address

 Produces a locally-administered unicast MAC address with the IPv4 address
 encoded in the last four octets (e.g. `192.0.2.1` → `02:00:c0:00:02:01`).

### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| `ip` | `Ip4` | IPv4 address to map to an ethernet address |

### Returns

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