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 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
use crate::{
object::{ComposeRequest, ObjectList},
ListRequest, Object,
};
use futures_util::TryStreamExt;
/// Operations on [`Object`](Object)s.
#[derive(Debug)]
pub struct ObjectClient<'a>(pub(super) &'a super::Client);
impl<'a> ObjectClient<'a> {
/// Create a new object.
/// Upload a file as that is loaded in memory to google cloud storage, where it will be
/// interpreted according to the mime type you specified.
/// ## Example
/// ```rust,no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// # fn read_cute_cat(_in: &str) -> Vec<u8> { vec![0, 1] }
/// use cloud_storage::sync::Client;
/// use cloud_storage::Object;
///
/// let file: Vec<u8> = read_cute_cat("cat.png");
/// let client = Client::new()?;
/// client.object().create("cat-photos", file, "recently read cat.png", "image/png")?;
/// # Ok(())
/// # }
/// ```
pub fn create(
&self,
bucket: &str,
file: Vec<u8>,
filename: &str,
mime_type: &str,
) -> crate::Result<Object> {
self.0.runtime.block_on(
self.0
.client
.object()
.create(bucket, file, filename, mime_type),
)
}
/// Create a new object. This works in the same way as `ObjectClient::create`, except it does not need
/// to load the entire file in ram.
pub fn create_streamed<R>(
&self,
bucket: &str,
file: R,
length: impl Into<Option<u64>>,
filename: &str,
mime_type: &str,
) -> crate::Result<Object>
where
R: std::io::Read + Send + Sync + Unpin + 'static,
{
let stream = super::helpers::ReaderStream::new(file);
self.0.runtime.block_on(
self.0
.client
.object()
.create_streamed(bucket, stream, length, filename, mime_type),
)
}
/// Obtain a list of objects within this Bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::{Object, ListRequest};
///
/// let client = Client::new()?;
/// let all_objects = client.object().list("my_bucket", ListRequest::default())?;
/// # Ok(())
/// # }
/// ```
pub fn list(
&self,
bucket: &'a str,
list_request: ListRequest,
) -> crate::Result<Vec<ObjectList>> {
let rt = &self.0.runtime;
let listed = rt.block_on(self.0.client.object().list(bucket, list_request))?;
rt.block_on(listed.try_collect())
}
/// Obtains a single object with the specified name in the specified bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::Object;
///
/// let client = Client::new()?;
/// let object = client.object().read("my_bucket", "path/to/my/file.png")?;
/// # Ok(())
/// # }
/// ```
pub fn read(&self, bucket: &str, file_name: &str) -> crate::Result<Object> {
self.0
.runtime
.block_on(self.0.client.object().read(bucket, file_name))
}
/// Download the content of the object with the specified name in the specified bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::Object;
///
/// let client = Client::new()?;
/// let bytes = client.object().download("my_bucket", "path/to/my/file.png")?;
/// # Ok(())
/// # }
/// ```
pub fn download(&self, bucket: &str, file_name: &str) -> crate::Result<Vec<u8>> {
self.0
.runtime
.block_on(self.0.client.object().download(bucket, file_name))
}
/// Obtains a single object with the specified name in the specified bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::Object;
///
/// let client = Client::new()?;
/// let mut object = client.object().read("my_bucket", "path/to/my/file.png")?;
/// object.content_type = Some("application/xml".to_string());
/// client.object().update(&object)?;
/// # Ok(())
/// # }
/// ```
pub fn update(&self, object: &Object) -> crate::Result<Object> {
self.0
.runtime
.block_on(self.0.client.object().update(object))
}
/// Deletes a single object with the specified name in the specified bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::Object;
///
/// let client = Client::new()?;
/// client.object().delete("my_bucket", "path/to/my/file.png")?;
/// # Ok(())
/// # }
/// ```
pub fn delete(&self, bucket: &str, file_name: &str) -> crate::Result<()> {
self.0
.runtime
.block_on(self.0.client.object().delete(bucket, file_name))
}
/// Obtains a single object with the specified name in the specified bucket.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::object::{Object, ComposeRequest, SourceObject};
///
/// let client = Client::new()?;
/// let obj1 = client.object().read("my_bucket", "file1")?;
/// let obj2 = client.object().read("my_bucket", "file2")?;
/// let compose_request = ComposeRequest {
/// kind: "storage#composeRequest".to_string(),
/// source_objects: vec![
/// SourceObject {
/// name: obj1.name.clone(),
/// generation: None,
/// object_preconditions: None,
/// },
/// SourceObject {
/// name: obj2.name.clone(),
/// generation: None,
/// object_preconditions: None,
/// },
/// ],
/// destination: None,
/// };
/// let obj3 = client.object().compose("my_bucket", &compose_request, "test-concatted-file")?;
/// // obj3 is now a file with the content of obj1 and obj2 concatted together.
/// # Ok(())
/// # }
/// ```
pub fn compose(
&self,
bucket: &str,
req: &ComposeRequest,
destination_object: &str,
) -> crate::Result<Object> {
self.0.runtime.block_on(
self.0
.client
.object()
.compose(bucket, req, destination_object),
)
}
/// Copy this object to the target bucket and path
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::object::{Object, ComposeRequest};
///
/// let client = Client::new()?;
/// let obj1 = client.object().read("my_bucket", "file1")?;
/// let obj2 = client.object().copy(&obj1, "my_other_bucket", "file2")?;
/// // obj2 is now a copy of obj1.
/// # Ok(())
/// # }
/// ```
pub fn copy(
&self,
object: &Object,
destination_bucket: &str,
path: &str,
) -> crate::Result<Object> {
self.0.runtime.block_on(
self.0
.client
.object()
.copy(object, destination_bucket, path),
)
}
/// Moves a file from the current location to the target bucket and path.
///
/// ## Limitations
/// This function does not yet support rewriting objects to another
/// * Geographical Location,
/// * Encryption,
/// * Storage class.
/// These limitations mean that for now, the rewrite and the copy methods do the same thing.
/// ### Example
/// ```no_run
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// use cloud_storage::sync::Client;
/// use cloud_storage::object::Object;
///
/// let client = Client::new()?;
/// let obj1 = client.object().read("my_bucket", "file1")?;
/// let obj2 = client.object().rewrite(&obj1, "my_other_bucket", "file2")?;
/// // obj2 is now a copy of obj1.
/// # Ok(())
/// # }
/// ```
pub fn rewrite(
&self,
object: &Object,
destination_bucket: &str,
path: &str,
) -> crate::Result<Object> {
self.0.runtime.block_on(
self.0
.client
.object()
.rewrite(object, destination_bucket, path),
)
}
}