Struct edjx::StorageResponse
source · pub struct StorageResponse { /* private fields */ }
Expand description
Response to the crate::storage::get
request.
Implementations§
source§impl StorageResponse
impl StorageResponse
sourcepub fn new() -> Result<StorageResponse, StorageError>
pub fn new() -> Result<StorageResponse, StorageError>
Examples found in repository?
src/storage.rs (line 111)
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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
pub fn get<B, FN>(bucket_id: B, file_name: FN) -> Result<StorageResponse, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_get(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
StorageResponse::new()
}
/// Uploads a file to the EDJX Object Store.
///
/// # Example
///
/// ```
/// let file_name = "example.txt";
/// let bucket_id = "af66ad83-e55b-4a71-a7d5-6ec3199e42e9";
///
/// let buf_data = b"Sample data for upload";
/// let properties = "Cache-Control=true,Type=text";
///
/// let put_res: StorageResponse = match storage::put(&bucket_id, &file_name, &properties , &buf_data.as_ref()) {
/// Ok(r) => r,
/// Err(e) => {
/// return HttpResponse::from(e.to_string().as_str().to_owned())
/// .set_status(e.to_http_status_code())
/// }
/// };
/// ```
pub fn put<B, FN, A, O>(
bucket_id: B,
file_name: FN,
properties: A,
contents: O,
) -> Result<StorageResponse, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
A: AsRef<str>,
O: AsRef<[u8]>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
let content_data = contents.as_ref();
let attributes_data = properties.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
if content_data.len() == 0 {
return Err(StorageError::EmptyContent);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_put(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
attributes_data.as_ptr(),
attributes_data.len() as u32,
content_data.as_ptr(),
content_data.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
StorageResponse::new()
}
/// Starts streaming a file to the EDJX Object Store. This method returns a [`WriteStream`]
/// and a [`StorageResponsePending`]. The [`WriteStream`] is used to stream data, the [`StorageResponsePending`]
/// is a placeholder to retreive [`StorageResponse`].
///
/// # Error Response
///
/// This method returns an error response of kind [`StorageError`]
///
/// # Example
///
/// ```no_run
/// use edjx::{storage, StorageResponse, BaseStream};
///
/// let file_name = "example.txt";
/// let bucket_id = "af66ad83-e55b-4a71-a7d5-6ec3199e42e9";
/// let properties = "Cache-Control=true,Type=text";
///
/// let (storage_resp_pending, mut write_stream) = storage::put_streaming(&bucket_id, &file_name, &properties).unwrap();
///
/// write_stream.write_chunk_text("A chunk of text").unwrap();
/// write_stream.write_chunk_binary(Vec::from("A chunk of binary data")).unwrap();
/// write_stream.close().unwrap();
///
/// let storage_res: StorageResponse = storage_resp_pending.get_storage_response().unwrap();
///
/// ```
pub fn put_streaming<B, FN, A>(
bucket_id: B,
file_name: FN,
properties: A,
) -> Result<(StorageResponsePending, WriteStream), StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
A: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
let attributes_data = properties.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
let mut error_code: i32 = 0;
let mut sd: u32 = 0;
let response_value = unsafe {
host_storage_put_streaming(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
attributes_data.as_ptr(),
attributes_data.len() as u32,
&mut sd,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
Ok((StorageResponsePending::new(sd), BaseStream::new(sd)))
}
/// Deletes the given file from the EDJX Object Store.
///
///
/// # Example
///
/// ```
/// let bucket_id = "af66ad83-e55b-4a71-a7d5-6ec3199e42e9";
/// let file_name = "example.txt";
///
/// let mut res_bytes: StorageResponse = match storage::delete(&bucket_id, &file_name) {
/// Ok(r) => r,
/// Err(e) => {
/// return HttpResponse::from(e.to_string().as_str().to_owned())
/// .set_status(e.to_http_status_code())
/// }
/// };
/// ```
pub fn delete<B, FN>(bucket_id: B, file_name: FN) -> Result<StorageResponse, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_delete(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
StorageResponse::new()
}
/// Returns attributes associated with the given file from the EDJX Object Store.
///
/// # Example
///
/// ```
/// let bucket_id = "af66ad83-e55b-4a71-a7d5-6ec3199e42e9";
/// let file_name = "example.txt";
///
/// let mut attributes: FileAttributes = match storage::get_attributes(&bucket_id, &file_name) {
/// Ok(r) => r,
/// Err(e) => {
/// return HttpResponse::from(e.to_string().as_str().to_owned())
/// .set_status(e.to_http_status_code())
/// }
/// };
/// ```
///
pub fn get_attributes<B, FN>(bucket_id: B, file_name: FN) -> Result<FileAttributes, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_get_attributes(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
let mut resp = match StorageResponse::new() {
Ok(resp) => resp,
Err(err) => return Err(err),
};
match resp.read_body() {
Ok(body) => FileAttributes::from_bytes(body),
Err(_) => Err(StorageError::InternalError),
}
}
/// Sets the attributes associated with the given file.
///
/// This setting replaces the existing attributes.
///
/// # Example
///
/// ```
/// let bucket_id = "af66ad83-e55b-4a71-a7d5-6ec3199e42e9";
/// let file_name = "example.txt";
///
/// let mut properties: HashMap<String, String> = HashMap::new();
/// properties.insert("Content-Type".to_owned(), "image/jpeg".to_owned());
/// properties.insert("Cache-Control".to_owned(), "image/jpeg".to_owned());
///
/// let new_attributes = FileAttributes::new(Some(properties), None);
///
/// let mut res_bytes: StorageResponse = match storage::set_attributes(&bucket_id, &file_name, new_attributes) {
/// Ok(r) => r,
/// Err(e) => {
/// return HttpResponse::from(e.to_string().as_str().to_owned())
/// .set_status(e.to_http_status_code())
/// }
/// };
/// ```
///
pub fn set_attributes<B, FN>(
bucket_id: B,
file_name: FN,
attributes: FileAttributes,
) -> Result<StorageResponse, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
let attributes_data = serde_json::to_vec(&attributes)?;
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
if attributes_data.len() == 0 {
return Err(StorageError::MissingAttributes);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_set_attributes(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
attributes_data.as_ptr(),
attributes_data.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
StorageResponse::new()
}
sourcepub fn headers(&self) -> &HashMap<String, String>
pub fn headers(&self) -> &HashMap<String, String>
Returns the metadata associated with the storage object.
sourcepub fn read_body(&mut self) -> Result<Vec<u8>, StreamError>
pub fn read_body(&mut self) -> Result<Vec<u8>, StreamError>
Retrieves the bytes of the storage object.
Examples found in repository?
src/storage.rs (line 362)
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
pub fn get_attributes<B, FN>(bucket_id: B, file_name: FN) -> Result<FileAttributes, StorageError>
where
B: AsRef<str>,
FN: AsRef<str>,
{
let bucket_id_str = bucket_id.as_ref();
let file_name_str = file_name.as_ref();
if file_name_str.trim().is_empty() {
return Err(StorageError::MissingFileName);
}
if bucket_id_str.trim().is_empty() {
return Err(StorageError::MissingBucketID);
}
let mut error_code: i32 = 0;
let response_value = unsafe {
host_storage_get_attributes(
bucket_id_str.as_ptr(),
bucket_id_str.len() as u32,
file_name_str.as_ptr(),
file_name_str.len() as u32,
&mut error_code,
)
};
if response_value < 0 {
return Err(StorageError::from(Error::from_i32(error_code).unwrap()));
}
let mut resp = match StorageResponse::new() {
Ok(resp) => resp,
Err(err) => return Err(err),
};
match resp.read_body() {
Ok(body) => FileAttributes::from_bytes(body),
Err(_) => Err(StorageError::InternalError),
}
}
sourcepub fn get_read_stream(&mut self) -> &mut ReadStream
pub fn get_read_stream(&mut self) -> &mut ReadStream
Returns the read stream.