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
//! # Reloading
//!
//! Rust module provides reloading feature that can be used for
//! easier development, avoiding server restart and client reconnect
//!
//! > note: currently, it works a bit better on Linux than on Windows.
//! Background threads spawned by Rust resources are not checked on Windows
//! which can lead to Undefined Behavior. See also [before_unload](#before_unload).
//!
//! ## How to use
//!
//! > note: ready-made [example](https://github.com/xxshady/altv-rust/tree/release/examples/reloading#how-to-run).
//!
//! To use it:
//!
//! ...compile rust-module with reloading enabled:
//! ```txt
//! cargo altvup release --reloading
//! ```
//!
//! ...compile your resource with `reloading` feature enabled on `altv` crate,
//! you can do so by adding the following to your Cargo.toml:
//! ```toml
//! [features]
//! reloading = ["altv/reloading"]
//! ```
//!
//! ...and running something like:
//! ```txt
//! cargo build --features reloading
//! ```
//!
//! ...now start altv-server, run in it:
//! ```txt
//! stop <your resource name>
//! ```
//!
//! ...recompile your resource and run in altv-server:
//! ```txt
//! start <your resource name>
//! ```
//!
//! > note: `stop` and `start` are alt:V built-in [commands](https://docs.altv.mp/articles/commandlineargs.html#server-commands).
//! It's also possible to reload resources programmatically using `altv::Resource::current().stop/start`
//!
//! ## Cleanup at unloading
//!
//! Rust module will cleanup everything owned (created) by Rust resource when it's unloaded:
//! - Destroy all baseobjects (colshapes, vehicles, etc.)
//! - Delete all metadata, including metadata set on connected players
//!
//! > note: connected players do not disappear in a magical way when resource is unloaded,
//! so be prepared to handle already connected players when resource starts in a different way,
//! player connect event won't be called for them.
//!
//! ## `before_unload`
//!
//! Rust module provides [`altv::before_unload`](https://docs.rs/altv/latest/altv/attr.before_unload.html)
//! callback API when something needs to be cleaned up manually when resource is unloaded.
//!
//! ## More details
//!
//! For more details about reloading feature see [relib](https://github.com/xxshady/relib).
//! About caveats, only [*File descriptors and network sockets*](https://github.com/xxshady/relib?tab=readme-ov-file#file-descriptors-and-network-sockets)
//! and [*Dead locks*](https://github.com/xxshady/relib?tab=readme-ov-file#dead-locks) apply to Rust module, txt the rest.