openstack 0.6.0

OpenStack SDK for Rust
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
99
100
101
102
103
104
105

// Copyright 2024 Sandro-Alessio Gierens <sandro@gierens.de>
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Foundation bits exposing the Block Storage API.

use std::fmt::Debug;

use osauth::services::BLOCK_STORAGE;
use osauth::ErrorKind;
use serde::Serialize;

use super::super::session::Session;
use super::super::utils;
use super::super::Result;
use super::protocol::*;

/// Delete a volume.
pub async fn delete_volume<S: AsRef<str>>(session: &Session, id: S) -> Result<()> {
    trace!("Deleting volume {}", id.as_ref());
    let _ = session
        .delete(BLOCK_STORAGE, &["volumes", id.as_ref()])
        .send()
        .await?;
    debug!("Successfully requested deletion of volume {}", id.as_ref());
    Ok(())
}

/// Get an volume.
pub async fn get_volume<S: AsRef<str>>(session: &Session, id_or_name: S) -> Result<Volume> {
    let s = id_or_name.as_ref();
    match get_volume_by_id(session, s).await {
        Ok(value) => Ok(value),
        Err(err) if err.kind() == ErrorKind::ResourceNotFound => {
            get_volume_by_name(session, s).await
        }
        Err(err) => Err(err),
    }
}

/// Get an volume by its ID.
pub async fn get_volume_by_id<S: AsRef<str>>(session: &Session, id: S) -> Result<Volume> {
    trace!("Fetching volume {}", id.as_ref());
    let root: VolumeRoot = session
        .get(BLOCK_STORAGE, &["volumes", id.as_ref()])
        .fetch()
        .await?;
    trace!("Received {:?}", root.volume);
    Ok(root.volume)
}

/// Get an volume by its name.
pub async fn get_volume_by_name<S: AsRef<str>>(session: &Session, name: S) -> Result<Volume> {
    trace!("Get volume by name {}", name.as_ref());
    let root: VolumesRoot = session
        .get(BLOCK_STORAGE, &["volumes"])
        .query(&[("name", name.as_ref())])
        .fetch()
        .await?;
    let result = utils::one(
        root.volumes,
        "Volume with given name or ID not found",
        "Too many volumes found with given name",
    )?;
    trace!("Received {:?}", result);
    Ok(result)
}

/// List volumes.
pub async fn list_volumes<Q: Serialize + Sync + Debug>(
    session: &Session,
    query: &Q,
) -> Result<Vec<Volume>> {
    trace!("Listing volumes with {:?}", query);
    let root: VolumesRoot = session
        .get(BLOCK_STORAGE, &["volumes", "detail"])
        .query(query)
        .fetch()
        .await?;
    trace!("Received volumes: {:?}", root.volumes);
    Ok(root.volumes)
}

/// Create a volume.
pub async fn create_volume(session: &Session, request: VolumeCreate) -> Result<Volume> {
    debug!("Creating a volume with {:?}", request);
    let body = VolumeCreateRoot { volume: request };
    let root: VolumeRoot = session
        .post(BLOCK_STORAGE, &["volumes"])
        .json(&body)
        .fetch()
        .await?;
    trace!("Requested creation of volume {:?}", root.volume);
    Ok(root.volume)
}