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
<!-- Generated by box-gantry. DO NOT EDIT. -->
# CollectionsManager
Reach these methods through the `collections` field on `client::Client`.
## list
`GET /collections`
| Parameter | In | Type | Required |
|---|---|---|---|
| `fields` | query | `Vec<String>` | no |
| `offset` | query | `i64` | no |
| `limit` | query | `i64` | no |
**Returns:** `Collections`
**Example**
```rust
let mut pages = client.collections.list(None);
while let Some(item) = pages.next().await {
// use item
}
```
Paginated — `list(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).
## list_items
`GET /collections/{collection_id}/items`
| Parameter | In | Type | Required |
|---|---|---|---|
| `collection_id` | path | `String` | yes |
| `fields` | query | `Vec<String>` | no |
| `offset` | query | `i64` | no |
| `limit` | query | `i64` | no |
**Returns:** `ItemsOffsetPaginated`
**Example**
```rust
let mut pages = client.collections.list_items("COLLECTION_ID".to_string(), None);
while let Some(item) = pages.next().await {
// use item
}
```
Paginated — `list_items(...)` returns a paginator you drive with `.next().await`, threading the cursor for you. See the [pagination guide](../pagination.md).
## get
`GET /collections/{collection_id}`
| Parameter | In | Type | Required |
|---|---|---|---|
| `collection_id` | path | `String` | yes |
**Returns:** `Collection`
**Example**
```rust
let result = client.collections.get("COLLECTION_ID".to_string()).await?;
```