rcon2mc 0.1.0

A RCON client lib for Minecraft server.
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

Controls server saving behavior.

This function sends one of the save‑related commands to the server via RCON.
The `save_type` parameter determines which action is performed:

- `"all"`  – Sends `save-all`. Immediately saves all player data and marks all
             chunks for saving; chunks are saved to disk gradually over time.
- `"off"`  – Sends `save-off`. Disables automatic world saving (except for
             player data, statistics, and advancements). This allows safe
             external copying of world files while the server is running;
             chunk changes are queued until saving is re‑enabled.
- `"on"`   – Sends `save-on`. Re‑enables automatic world saving after it has
             been disabled with `save-off`.

# Arguments

* `save_type` – A string slice specifying the save operation. Must be one of
  `"all"`, `"off"`, or `"on"`.

# Returns

* `Ok(())` – The command was successfully sent and acknowledged by the server.
* `Err(RconError)` – An error occurred during the RCON communication, or the
  provided `save_type` is invalid (in which case [`RconError::InvalidCommandError`]
  is returned).

# Errors

This function will return an error in the following situations:
- The `save_type` is not one of `"all"`, `"off"`, or `"on"`.
- The RCON connection fails or times out.
- The server returns an "Unknown or incomplete command" response,
  indicating that the save command is not available or the server
  is in an unexpected state.
- Any underlying I/O or protocol error during the RCON exchange.

# Example

```no_run
use rcon2mc::rcon_client::RconClient;

let mut client = RconClient::builder()
    .host("localhost".to_string())
    .port(25575)
    .password("password".to_string())
    .build()
    .expect("failed to connect");

// Save all data immediately
client.command().save("all").expect("save-all failed");
let mut client = RconClient::builder()
    .host("localhost".to_string())
    .port(25575)
    .password("password".to_string())
    .build()
    .expect("failed to connect");

// Disable auto‑save to copy world files
client.command().save("off").expect("save-off failed");
let mut client = RconClient::builder()
    .host("localhost".to_string())
    .port(25575)
    .password("password".to_string())
    .build()
    .expect("failed to connect");
// ... copy world directory ...
client.command().save("on").expect("save-on failed");
```