digitalocean 0.0.2

A crate for accessing and interacting with the DigitalOcean API.
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

use super::{ApiLinks, ApiMeta};
use super::{HasPagination, HasResponse, HasValue};
use {ROOT_URL, STATIC_URL_ERROR};
use method::List;
use request::Request;
use request::SizeRequest;
use url::Url;

const SIZES_SEGMENT: &'static str = "sizes";

/// The sizes objects represent different packages of hardware resources that
/// can be used for Droplets. When a Droplet is created, a size must be
/// selected so that the correct resources can be allocated.
///
/// Each size represents a plan that bundles together specific sets of
/// resources. This includes the amount of RAM, the number of virtual CPUs,
/// disk space, and transfer. The size object also includes the pricing
/// details and the regions that the size is available in.
///
/// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#sizes)
#[derive(Deserialize, Serialize, Debug, Clone, Getters, Setters)]
pub struct Size {
    /// A human-readable string that is used to uniquely identify each size.
    #[get = "pub"]
    slug: String,
    /// This is a boolean value that represents whether new Droplets can be
    /// created with this size.
    #[get = "pub"]
    available: bool,
    /// The amount of transfer bandwidth that is available for Droplets created
    /// in this size. This only counts traffic on the public interface. The
    /// value is given in terabytes.
    #[get = "pub"]
    transfer: f64,
    /// This attribute describes the monthly cost of this Droplet size if the
    /// Droplet is kept for an entire month. The value is measured in US
    /// dollars.
    #[get = "pub"]
    price_monthly: f64,
    /// This describes the price of the Droplet size as measured hourly. The
    /// value is measured in US dollars.
    #[get = "pub"]
    price_hourly: f64,
    /// The amount of RAM allocated to Droplets created of this size. The value
    /// is represented in megabytes.
    #[get = "pub"]
    memory: usize,
    /// The number of virtual CPUs allocated to Droplets of this size.
    #[get = "pub"]
    vcpus: usize,
    /// The amount of disk space set aside for Droplets of this size. The value
    /// is represented in gigabytes.
    #[get = "pub"]
    disk: usize,
    /// An array containing the region slugs where this size is available for
    /// Droplet creates.
    #[get = "pub"]
    regions: Vec<String>,
}

impl Size {
    /// [Digital Ocean Documentation.](https://developers.digitalocean.com/documentation/v2/#list-all-images)
    pub fn list() -> SizeRequest<List, Vec<Size>> {
        let mut url = ROOT_URL.clone();
        url.path_segments_mut().expect(STATIC_URL_ERROR).push(
            SIZES_SEGMENT,
        );

        Request::new(url)
    }
}

// There is no signular size return.

/// Response type returned from Digital Ocean.
#[derive(Deserialize, Serialize, Debug, Clone)]
pub struct SizeListResponse {
    sizes: Vec<Size>,
    links: ApiLinks,
    meta: ApiMeta,
}

impl HasResponse for Vec<Size> {
    type Response = SizeListResponse;
}

impl HasPagination for SizeListResponse {
    fn next_page(&self) -> Option<Url> {
        self.links.next()
    }
}

impl HasValue for SizeListResponse {
    type Value = Vec<Size>;
    fn value(self) -> Vec<Size> {
        self.sizes
    }
}