synapse-rpc 0.1.20

RPC data structures used by synapse
Documentation
use std::borrow::Cow;

use chrono::{DateTime, Utc};

use super::resource::{CResourceUpdate, ResourceKind, SResourceUpdate};
use super::criterion::Criterion;

#[derive(Copy, Clone, Debug, Serialize, Deserialize)]
pub struct Version {
    pub major: u16,
    pub minor: u16,
}

/// Client -> server messages
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
#[serde(tag = "type")]
#[serde(deny_unknown_fields)]
pub enum CMessage {
    // Standard messages
    GetResources {
        serial: u64,
        ids: Vec<String>,
    },
    Subscribe {
        serial: u64,
        ids: Vec<String>,
    },
    Unsubscribe {
        serial: u64,
        ids: Vec<String>,
    },
    UpdateResource {
        serial: u64,
        resource: CResourceUpdate,
    },
    RemoveResource {
        serial: u64,
        id: String,
        #[serde(default)]
        artifacts: Option<bool>,
    },
    FilterSubscribe {
        serial: u64,
        #[serde(default)]
        kind: ResourceKind,
        #[serde(default)]
        criteria: Vec<Criterion>,
    },
    FilterUnsubscribe {
        serial: u64,
        filter_serial: u64,
    },

    // Special messages
    UploadTorrent {
        serial: u64,
        size: u64,
        path: Option<String>,
        #[serde(default = "default_true")]
        start: bool,
        #[serde(default = "default_false")]
        import: bool,
    },
    UploadMagnet {
        serial: u64,
        uri: String,
        path: Option<String>,
        #[serde(default = "default_true")]
        start: bool,
    },
    UploadFiles {
        serial: u64,
        size: u64,
        path: String,
    },
    PauseTorrent {
        serial: u64,
        id: String,
    },
    ResumeTorrent {
        serial: u64,
        id: String,
    },
    UpdateTracker {
        serial: u64,
        id: String,
    },
    AddTracker {
        serial: u64,
        id: String,
        uri: String,
    },
    AddPeer {
        serial: u64,
        id: String,
        ip: String,
    },
    ValidateResources {
        serial: u64,
        ids: Vec<String>,
    },
    PurgeDns {
        serial: u64,
    },
}

/// Server -> client message
#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
#[serde(tag = "type")]
#[serde(deny_unknown_fields)]
pub enum SMessage<'a> {
    // Standard messages
    ResourcesExtant {
        serial: u64,
        ids: Vec<Cow<'a, str>>,
    },
    ResourcesRemoved {
        serial: u64,
        ids: Vec<String>,
    },
    UpdateResources {
        serial: Option<u64>,
        resources: Vec<SResourceUpdate<'a>>,
    },

    // Special messages
    RpcVersion(Version),
    TransferOffer {
        serial: u64,
        expires: DateTime<Utc>,
        token: String,
        size: u64,
    },
    ResourcePending {
        serial: u64,
        id: String,
    },

    // Error messages
    UnknownResource(Error),
    InvalidResource(Error),
    InvalidSchema(Error),
    InvalidRequest(Error),
    PermissionDenied(Error),
    TransferFailed(Error),
}

#[derive(Clone, Debug, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Error {
    pub serial: Option<u64>,
    pub reason: String,
}

impl Version {
    pub fn current() -> Version {
        Version {
            major: ::MAJOR_VERSION,
            minor: ::MINOR_VERSION,
        }
    }
}

fn default_true() -> bool {
    true
}

fn default_false() -> bool {
    false
}

#[cfg(test)]
mod tests {
    extern crate serde_json;
    use super::*;
    use super::super::{criterion, resource};

    #[test]
    fn test_json_repr() {
        let data = r#"
            {
                "type": "FILTER_SUBSCRIBE",
                "serial": 0,
                "criteria": [
                    { "field": "id", "op": "in", "value": [1,2,null] }
                ]
            }
            "#;
        let m = serde_json::from_str(data).unwrap();
        if let CMessage::FilterSubscribe {
            kind: resource::ResourceKind::Torrent,
            serial: 0,
            criteria: c,
        } = m
        {
            assert_eq!(c[0].field, "id");
            assert_eq!(c[0].op, criterion::Operation::In);
            let v = vec![
                criterion::Value::N(1),
                criterion::Value::N(2),
                criterion::Value::E(None),
            ];
            assert_eq!(c[0].value, criterion::Value::V(v));
        } else {
            unreachable!();
        }
    }
}