ossify 0.4.0

A modern, easy-to-use, and reqwest-powered Rust SDK for Alibaba Cloud Object Storage Service (OSS)
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
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
use std::collections::HashMap;
use std::future::Future;

use http::Method;
use serde::de::IntoDeserializer;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

use crate::body::XMLBody;
use crate::error::Result;
use crate::response::BodyResponseProcessor;
use crate::ser::OnlyKeyField;
use crate::{Client, Ops, Prepared, Request};

/// Query mode
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum DoMetaQueryMode {
    /// Basic query
    Basic,
    /// Semantic query (vector search)
    Semantic,
}

impl Default for DoMetaQueryMode {
    fn default() -> Self {
        Self::Basic
    }
}

impl AsRef<str> for DoMetaQueryMode {
    fn as_ref(&self) -> &str {
        match self {
            DoMetaQueryMode::Basic => "basic",
            DoMetaQueryMode::Semantic => "semantic",
        }
    }
}

/// Sort order
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum SortOrder {
    /// Ascending order
    Asc,
    /// Descending order
    Desc,
}

impl Default for SortOrder {
    fn default() -> Self {
        Self::Asc
    }
}

impl AsRef<str> for SortOrder {
    fn as_ref(&self) -> &str {
        match self {
            SortOrder::Asc => "asc",
            SortOrder::Desc => "desc",
        }
    }
}

/// Media type (used for vector search)
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum MediaType {
    Image,
    Video,
    Audio,
    Document,
}

impl AsRef<str> for MediaType {
    fn as_ref(&self) -> &str {
        match self {
            MediaType::Image => "image",
            MediaType::Video => "video",
            MediaType::Audio => "audio",
            MediaType::Document => "document",
        }
    }
}

/// Aggregation operation type
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum AggregationOperation {
    /// Calculate sum
    Sum,
    /// Calculate average
    Avg,
    /// Calculate maximum
    Max,
    /// Calculate minimum
    Min,
    /// Calculate count
    Count,
    /// Group statistics
    Group,
}

impl AsRef<str> for AggregationOperation {
    fn as_ref(&self) -> &str {
        match self {
            AggregationOperation::Sum => "sum",
            AggregationOperation::Avg => "avg",
            AggregationOperation::Max => "max",
            AggregationOperation::Min => "min",
            AggregationOperation::Count => "count",
            AggregationOperation::Group => "group",
        }
    }
}

/// Aggregation configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct Aggregation {
    /// Aggregation field
    pub field: String,
    /// Aggregation operation
    pub operation: AggregationOperation,
}

/// Aggregation result
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct AggregationResult {
    /// Aggregation field
    pub field: String,
    /// Aggregation operation
    pub operation: String,
    /// Aggregation value
    pub value: Option<String>,
    /// Group results (only when operation is group)
    #[serde(default)]
    pub groups: Vec<AggregationGroup>,
}

/// Aggregated group results
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct AggregationGroup {
    /// Group value
    pub value: String,
    /// Group count
    pub count: u64,
}

/// Address information
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct Address {
    pub address_line: Option<String>,
    pub city: Option<String>,
    pub country: Option<String>,
    pub district: Option<String>,
    pub language: Option<String>,
    pub province: Option<String>,
    pub township: Option<String>,
}

/// Video stream information
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct VideoStream {
    pub codec_name: Option<String>,
    pub language: Option<String>,
    pub bitrate: Option<String>,
    pub frame_rate: Option<String>,
    pub start_time: Option<String>,
    pub duration: Option<String>,
    pub frame_count: Option<String>,
    pub bit_depth: Option<String>,
    pub pixel_format: Option<String>,
    pub color_space: Option<String>,
    pub height: Option<u32>,
    pub width: Option<u32>,
}

/// Audio stream information
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct AudioStream {
    pub codec_name: Option<String>,
    pub bitrate: Option<String>,
    pub sample_rate: Option<String>,
    pub start_time: Option<String>,
    pub duration: Option<String>,
    pub channels: Option<String>,
    pub language: Option<String>,
}

/// Subtitle information
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct Subtitle {
    pub codec_name: Option<String>,
    pub language: Option<String>,
    pub start_time: Option<String>,
    pub duration: Option<String>,
}

/// File information
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct FileInfo {
    /// File name
    pub filename: String,
    /// File size (bytes)
    pub size: u64,
    /// File last modified time
    pub file_modified_time: Option<String>,
    /// Object last modified time
    #[serde(rename = "OSSObjectLastModifiedTime")]
    pub oss_object_last_modified_time: Option<String>,
    /// ETag
    #[serde(rename = "ETag")]
    pub etag: Option<String>,
    /// CRC64
    #[serde(rename = "OSSCRC64")]
    pub oss_crc64: Option<String>,
    /// Creation time
    pub produce_time: Option<String>,
    /// Content type
    pub content_type: Option<String>,
    /// Media type
    pub media_type: Option<String>,
    /// Longitude and latitude coordinates
    pub lat_long: Option<String>,
    /// Title
    pub title: Option<String>,
    /// Expiration time
    #[serde(rename = "OSSExpiration")]
    pub oss_expiration: Option<String>,
    /// Cache control
    pub cache_control: Option<String>,
    /// Content description
    pub content_disposition: Option<String>,
    /// Content encoding
    pub content_encoding: Option<String>,
    /// Content language
    pub content_language: Option<String>,
    /// Access control allow origin
    pub access_control_allow_origin: Option<String>,
    /// Access control request method
    pub access_control_request_method: Option<String>,
    /// Server-side data encryption
    pub server_side_data_encryption: Option<String>,
    /// Server-side encryption key ID
    pub server_side_encryption_key_id: Option<String>,
    /// Image height
    pub image_height: Option<u32>,
    /// Image width
    pub image_width: Option<u32>,
    /// Video width
    pub video_width: Option<u32>,
    /// Video height
    pub video_height: Option<u32>,
    /// Bit rate
    pub bitrate: Option<String>,
    /// Artist
    pub artist: Option<String>,
    /// Album artist
    pub album_artist: Option<String>,
    /// Composer
    pub composer: Option<String>,
    /// Performer
    pub performer: Option<String>,
    /// Album
    pub album: Option<String>,
    /// Duration
    pub duration: Option<String>,
    /// Object type
    #[serde(rename = "OSSObjectType")]
    pub oss_object_type: Option<String>,
    /// Storage class
    #[serde(rename = "OSSStorageClass")]
    pub oss_storage_class: Option<String>,
    /// Tag count
    #[serde(rename = "OSSTaggingCount")]
    pub oss_tagging_count: Option<u32>,
    /// Video stream information
    #[serde(default)]
    pub video_streams: Vec<VideoStream>,
    /// Audio stream information
    #[serde(default)]
    pub audio_streams: Vec<AudioStream>,
    /// Subtitle information
    #[serde(default)]
    pub subtitles: Vec<Subtitle>,
    /// Address information
    #[serde(default)]
    pub addresses: Vec<Address>,
    /// Object tags
    #[serde(rename = "OSSTagging", default, deserialize_with = "unwrap_tagging")]
    pub tagging: HashMap<String, String>,
    /// User metadata
    #[serde(rename = "OSSUserMeta", default, deserialize_with = "unwrap_user_meta")]
    pub user_meta: HashMap<String, String>,
}

/// MetaQuery body
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Default)]
#[serde(rename = "MetaQuery", rename_all = "PascalCase")]
pub struct MetaQueryBody {
    /// Pagination token
    pub next_token: Option<String>,
    /// Maximum number of objects to return
    pub max_results: Option<u32>,
    /// Query condition (Basic query)
    pub query: Option<String>,
    /// Query condition (Vector search)
    pub simple_query: Option<String>,
    /// Sort field
    pub sort: Option<String>,
    /// Sort order
    pub order: Option<SortOrder>,
    /// Aggregation operation
    pub aggregations: Option<Vec<Aggregation>>,
    /// Media type (used for Vector search)
    pub media_types: Option<Vec<MediaType>>,
}

fn unwrap_files<'de, D>(deserializer: D) -> std::result::Result<Vec<FileInfo>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    #[derive(Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct Files {
        #[serde(default)]
        file: Vec<FileInfo>,
    }
    Ok(Files::deserialize(deserializer)?.file)
}

fn unwrap_aggregations<'de, D>(deserializer: D) -> std::result::Result<Vec<AggregationResult>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    #[derive(Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct Aggregations {
        #[serde(default)]
        aggregation: Vec<AggregationResult>,
    }
    Ok(Aggregations::deserialize(deserializer)?.aggregation)
}

fn unwrap_user_meta<'de, D>(de: D) -> std::result::Result<HashMap<String, String>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    /// User metadata
    #[derive(Debug, Clone, Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct UserMeta {
        pub key: String,
        pub value: String,
    }

    #[derive(Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct OSSUserMeta {
        #[serde(default)]
        user_meta: Vec<UserMeta>,
    }
    Ok(OSSUserMeta::deserialize(de)?
        .user_meta
        .into_iter()
        .map(|meta| {
            (
                meta.key
                    .to_lowercase()
                    .trim_start_matches("x-oss-meta-")
                    .to_string(),
                meta.value,
            )
        })
        .collect())
}

fn unwrap_tagging<'de, D>(de: D) -> std::result::Result<HashMap<String, String>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    /// Object tags
    #[derive(Debug, Clone, Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct Tagging {
        pub key: String,
        pub value: String,
    }

    #[derive(Deserialize)]
    #[serde(rename_all = "PascalCase")]
    struct OSSTagging {
        #[serde(default)]
        tagging: Vec<Tagging>,
    }
    Ok(OSSTagging::deserialize(de)?
        .tagging
        .into_iter()
        .map(|t| (t.key, t.value))
        .collect())
}

fn empty_string_as_none<'de, D, T>(de: D) -> std::result::Result<Option<T>, D::Error>
where
    D: serde::Deserializer<'de>,
    T: serde::Deserialize<'de>,
{
    let opt = Option::<String>::deserialize(de)?;
    let opt = opt.as_deref();
    match opt {
        None | Some("") => Ok(None),
        Some(s) => T::deserialize(s.into_deserializer()).map(Some),
    }
}

/// MetaQuery response
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct MetaQueryResponse {
    /// Next page token
    #[serde(deserialize_with = "empty_string_as_none")]
    // #[serde_as(as = "NoneAsEmptyString")]
    pub next_token: Option<String>,
    /// File list
    #[serde(default, deserialize_with = "unwrap_files")]
    pub files: Vec<FileInfo>,
    /// Aggregation result
    #[serde(default, deserialize_with = "unwrap_aggregations")]
    pub aggregations: Vec<AggregationResult>,
}

/// DoMetaQuery request parameters
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DoMetaQueryParams {
    pub mode: DoMetaQueryMode,
    pub comp: String,
    meta_query: OnlyKeyField,
}

impl Default for DoMetaQueryParams {
    fn default() -> Self {
        Self {
            meta_query: OnlyKeyField,
            mode: DoMetaQueryMode::Basic,
            comp: "query".to_string(),
        }
    }
}

/// DoMetaQuery operation
pub struct DoMetaQuery {
    pub mode: DoMetaQueryMode,
    pub body: MetaQueryBody,
    pub query: DoMetaQueryParams,
}

impl Ops for DoMetaQuery {
    type Response = BodyResponseProcessor<MetaQueryResponse>;
    type Body = XMLBody<MetaQueryBody>;
    type Query = DoMetaQueryParams;

    fn prepare(self) -> Result<Prepared<DoMetaQueryParams, MetaQueryBody>> {
        Ok(Prepared {
            method: Method::POST,
            query: Some(self.query),
            body: Some(self.body),
            ..Default::default()
        })
    }
}

/// DoMetaQueryOperations trait
pub trait DataIndexingOperations {
    /// Query files (objects) that meet the specified conditions
    ///
    /// Official documentation: <https://www.alibabacloud.com/help/en/oss/developer-reference/dometaquery>
    fn do_meta_query(
        &self,
        mode: DoMetaQueryMode,
        body: MetaQueryBody,
        query: DoMetaQueryParams,
    ) -> impl Future<Output = Result<MetaQueryResponse>>;
}

impl DataIndexingOperations for Client {
    async fn do_meta_query(
        &self,
        mode: DoMetaQueryMode,
        body: MetaQueryBody,
        query: DoMetaQueryParams,
    ) -> Result<MetaQueryResponse> {
        let ops = DoMetaQuery { mode, body, query };
        self.request(ops).await
    }
}

// =============================================================================
// Convenience builder and helper functions
// =============================================================================

/// Query builder for constructing complex query conditions
#[derive(Debug, Clone)]
pub struct QueryBuilder {
    conditions: Vec<QueryCondition>,
}

/// Query condition
#[derive(Debug, Clone)]
pub struct QueryCondition {
    pub field: String,
    pub operation: String,
    pub value: String,
}

impl QueryBuilder {
    pub fn new() -> Self {
        Self {
            conditions: Vec::new(),
        }
    }

    pub fn eq(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "eq".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn gt(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "gt".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn gte(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "gte".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn lt(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "lt".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn lte(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "lte".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn prefix(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "prefix".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn r#match(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.conditions.push(QueryCondition {
            field: field.into(),
            operation: "match".to_string(),
            value: value.into(),
        });
        self
    }

    pub fn build(self) -> Result<String> {
        if self.conditions.is_empty() {
            return Err(crate::error::Error::InvalidArgument(
                "Query conditions cannot be empty".to_string(),
            ));
        }

        if self.conditions.len() == 1 {
            let condition = &self.conditions[0];
            let query = serde_json::json!({
                "Field": condition.field,
                "Operation": condition.operation,
                "Value": condition.value
            });
            Ok(query.to_string())
        } else {
            let sub_queries: Vec<_> = self
                .conditions
                .iter()
                .map(|c| {
                    serde_json::json!({
                        "Field": c.field,
                        "Operation": c.operation,
                        "Value": c.value
                    })
                })
                .collect();

            let query = serde_json::json!({
                "Operation": "and",
                "SubQueries": sub_queries
            });
            Ok(query.to_string())
        }
    }
}

impl Default for QueryBuilder {
    fn default() -> Self {
        Self::new()
    }
}

/// MetaQueryRequest builder
#[derive(Debug, Clone)]
pub struct MetaQueryRequestBuilder {
    request: MetaQueryBody,
}

impl MetaQueryRequestBuilder {
    /// Create a new request builder
    pub fn new() -> Self {
        Self {
            request: MetaQueryBody {
                next_token: None,
                max_results: None,
                query: None,
                simple_query: None,
                sort: None,
                order: None,
                aggregations: None,
                media_types: None,
            },
        }
    }

    /// Set pagination token
    pub fn next_token(mut self, token: impl Into<String>) -> Self {
        self.request.next_token = Some(token.into());
        self
    }

    /// Set maximum number of results
    pub fn max_results(mut self, max: u32) -> Self {
        self.request.max_results = Some(max);
        self
    }

    /// Set query condition (for Basic query)
    pub fn query(mut self, query: impl Into<String>) -> Self {
        self.request.query = Some(query.into());
        self
    }

    /// Set simple query condition (for Vector search)
    pub fn simple_query(mut self, query: impl Into<String>) -> Self {
        self.request.simple_query = Some(query.into());
        self
    }

    /// Set sort field
    pub fn sort(mut self, field: impl Into<String>) -> Self {
        self.request.sort = Some(field.into());
        self
    }

    /// Set sort order
    pub fn order(mut self, order: SortOrder) -> Self {
        self.request.order = Some(order);
        self
    }

    /// Add aggregation operation
    pub fn aggregation(mut self, field: impl Into<String>, operation: AggregationOperation) -> Self {
        let aggregations = self.request.aggregations.get_or_insert_with(Vec::new);
        aggregations.push(Aggregation {
            field: field.into(),
            operation,
        });
        self
    }

    /// Set media type (for Vector search)
    pub fn media_types(mut self, types: Vec<MediaType>) -> Self {
        self.request.media_types = Some(types);
        self
    }

    /// Build request
    pub fn build(self) -> MetaQueryBody {
        self.request
    }
}

impl Default for MetaQueryRequestBuilder {
    fn default() -> Self {
        Self::new()
    }
}