memcached-network-types 0.1.1

Provides types for memcached protocol entities used for sending requests and responses over the network.
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
79

<p align="center">
<h1 align="center"><code>memcached-network-types</code></h1>
</p>

<p align="center">
  <a href="https://github.com/arindas/memcached-network-types/actions/workflows/rust-ci.yml">
    <img src="https://github.com/arindas/memcached-network-types/actions/workflows/rust-ci.yml/badge.svg">
  </a>
  <a href="https://crates.io/crates/memcached-network-types">
  <img src="https://img.shields.io/crates/v/memcached-network-types" />
  </a>
  <a href="https://github.com/arindas/memcached-network-types/actions/workflows/rustdoc.yml">
    <img src="https://github.com/arindas/memcached-network-types/actions/workflows/rustdoc.yml/badge.svg">
  </a>
</p>

<p align="center">
Provides types for memcached protocol entities used for sending requests and responses over the network.
</p>

## Usage

`memcached-network-types` is a `nostd` library crate. You may include it in your `Cargo.toml` as follows:

```toml
[dependencies]
memcached-network-types = "0.1.1"
```

Refer to latest git [API Documentation](https://arindas.github.io/memcached-network-types/docs/memcached_network_types/)
for more details.

### Example

```rust
use memcached_network_types::binary::*;

let req_get_packet_header = ReqPacketHeader {
    magic_byte: ReqMagicByte::ReqPacket,
    opcode: Opcode::Get,
    key_length: 0.into(),
    extras_length: 0,
    data_type: DataType::RawBytes,
    vbucket: 0.into(),
    total_body_length: 0.into(),
    opaque: [0; 4],
    cas: [0; 8],
};

let bytes = req_get_packet_header.as_bytes();

let req_get_packet_header_parsed = ReqPacketHeader::ref_from(bytes).unwrap();

assert!(&req_get_packet_header == req_get_packet_header_parsed);

let req_get_packet_header_parsed =
    ReqPacketHeader::ref_req_packet_header_with_possible_opcode_from(bytes, &[Opcode::Get])
        .unwrap();

assert!(&req_get_packet_header == req_get_packet_header_parsed);

const GET_OPCODE: u8 = Opcode::Get as u8;

let req_get_packet_header_parsed = unsafe {
    ReqPacketHeader::ref_req_packet_header_with_opcode_from::<GET_OPCODE>(bytes).unwrap()
};

assert!(&req_get_packet_header == req_get_packet_header_parsed);

let req_get_packet_header_parsed =
    ReqPacketHeader::ref_req_packet_header_with_get_opcode_from(bytes).unwrap();

assert!(&req_get_packet_header == req_get_packet_header_parsed);
```

## License

This repository is licensed under the MIT License. See
[LICENSE](https://raw.githubusercontent.com/arindas/memcached-network-types/main/LICENSE) for more details.