octocrab 0.52.0

A modern, extensible GitHub API client.
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

use crate::models::repos::Release;
use serde::{Deserialize, Serialize};

/// The payload in a [`super::EventPayload::ReleaseEvent`] type.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ReleaseEventPayload {
    /// The action this event represents.
    pub action: ReleaseEventAction,
    /// The release this event corresponds to.
    pub release: Release,
    /// The changes to body or name if this event is of type [`ReleaseEventAction::Edited`].
    pub changes: Option<ReleaseEventChanges>,
}

/// The change which occurred in an event of type [`ReleaseEventAction::Edited`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum ReleaseEventChanges {
    Body(ReleaseEventChangesFrom),
    Name(ReleaseEventChangesFrom),
}

/// The previous value of the item (either the body or title) of a release which has changed. Only
/// available in an event of type [`ReleaseEventAction::Edited`].
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct ReleaseEventChangesFrom {
    pub from: String,
}

/// The action on a release this event corresponds to.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
#[non_exhaustive]
pub enum ReleaseEventAction {
    Published,
    Edited,
}

#[cfg(test)]
mod test {
    use crate::models::events::{
        payload::{EventPayload, ReleaseEventAction},
        Event,
    };

    #[test]
    fn should_deserialize_with_correct_payload() {
        let json = include_str!("../../../../tests/resources/release_event.json");
        let event: Event = serde_json::from_str(json).unwrap();
        if let Some(EventPayload::ReleaseEvent(ref payload)) =
            event.payload.as_ref().unwrap().specific
        {
            assert_eq!(payload.action, ReleaseEventAction::Published);
        } else {
            panic!("unexpected event payload encountered: {:#?}", event.payload);
        }
    }
}