torrust-actix 4.1.2

A rich, fast and efficient Bittorrent Tracker.
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

//! Serde serialization definition for AnnounceEvent.

use serde::{Deserialize, Serialize};
use crate::tracker::enums::announce_event::AnnounceEvent;

/// Serde remote definition for serializing [`AnnounceEvent`].
///
/// This enum is used with `#[serde(with = "AnnounceEventDef")]` to enable
/// JSON serialization of announce events. It maps the internal numeric
/// representation to human-readable string names.
///
/// # Usage
///
/// ```rust,ignore
/// use serde::Serialize;
/// use crate::tracker::enums::announce_event::AnnounceEvent;
/// use crate::tracker::enums::announce_event_def::AnnounceEventDef;
///
/// #[derive(Serialize)]
/// struct MyStruct {
///     #[serde(with = "AnnounceEventDef")]
///     event: AnnounceEvent,
/// }
/// ```
///
/// # Serialization Format
///
/// Events are serialized as their variant names: `"Started"`, `"Stopped"`,
/// `"Completed"`, or `"None"`.
#[derive(Serialize, Deserialize)]
#[serde(remote = "AnnounceEvent")]
pub enum AnnounceEventDef {
    /// Serializes as `"Started"`.
    Started,

    /// Serializes as `"Stopped"`.
    Stopped,

    /// Serializes as `"Completed"`.
    Completed,

    /// Serializes as `"None"`.
    None,
}