Struct dishub::ops::Event

pub struct Event {
    pub created_at: DateTime<FixedOffset>,
    pub actor: String,
    pub repo: String,
    pub id: u64,
    pub payload: EventPayload,
}

A representation of the GitHub Event API's event.

Fields

created_at: DateTime<FixedOffset>

The time this event was generated.

Corresponds to created_at in the event JSON.

actor: String

The person who triggered the event.

Corresponds to actor.display_login in the event JSON.

repo: String

The repository slug where the event is triggered.

Corresponds to repo.name in the event JSON.

id: u64

The event ID.

Corresponds to id in the event JSON (except it's a string there).

payload: EventPayload

The event's payload.

Corresponds to payload in the event JSON, determined by type.

Methods

impl Event

pub fn parse(what: &str) -> Vec<Event>

Parse a raw JSON GitHub Events API response.

The JSON is not checked for correctness, so be wary.

Examples

// Shaved to minimum for brevity
let response = r#"[
                    {
                      "id": "4831774905",
                      "type": "WatchEvent",
                      "actor": {
                        "display_login": "carllhw"
                      },
                      "repo": {
                        "name": "nabijaczleweli/cargo-update"
                      },
                      "payload": {
                        "action": "started"
                      },
                      "created_at": "2016-11-08T03:10:26Z"
                    },
                    {
                      "id": "4831775201",
                      "type": "WatchEvent",
                      "actor": {
                        "display_login": "Byron-TW"
                      },
                      "repo": {
                        "name": "nabijaczleweli/cargo-update"
                      },
                      "payload": {
                        "action": "started"
                      },
                      "created_at": "2016-11-09T06:12:26Z"
                    }
                  ]"#;
assert_eq!(Event::parse(response), vec![
           Event {
               created_at: DateTime::parse_from_rfc2822("Tue, 8 Nov 2016 03:10:26 +0000").unwrap(),
               actor: "carllhw".to_string(),
               repo: "nabijaczleweli/cargo-update".to_string(),
               id: 4831774905,
               payload: EventPayload::Watch {
                   action: "started".to_string(),
               },
           },
           Event {
               created_at: DateTime::parse_from_rfc2822("Wed, 9 Nov 2016 06:12:26 +0000").unwrap(),
               actor: "Byron-TW".to_string(),
               repo: "nabijaczleweli/cargo-update".to_string(),
               id: 4831775201,
               payload: EventPayload::Watch {
                   action: "started".to_string(),
               },
           }
       ]);

pub fn urls(&self) -> Vec<String>

Get the reference URLs for an event.

Examples

// Shaved to minimum for brevity
let response = r#"[{
                    "id": "4831774905",
                    "type": "WatchEvent",
                    "actor": { "display_login": "carllhw" },
                    "repo": { "name": "nabijaczleweli/cargo-update" },
                    "payload": { "action": "started" },
                    "created_at": "2016-11-08T03:10:26Z"
                  }]"#;
assert_eq!(Event::parse(response)[0].urls(),
           vec!["https://github.com/nabijaczleweli/cargo-update/stargazers".to_string()]);

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for Event

impl PartialEq<Event> for Event

fn eq(&self, other: &Event) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Event) -> bool

This method tests for !=.

impl Hash for Event

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Display for Event

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Debug for Event

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.