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
use serde::{Deserialize, Serialize};
use thiserror::Error;
use crate::error::{BadRequestError, BadRequestResponse};
use crate::{Collection, PocketBase};
/// Represents the various errors that can be obtained after a `update` request.
#[derive(Error, Debug)]
pub enum UpdateError {
/// Communication with the `PocketBase` API was successful,
/// but returned a [400 Bad Request]("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400") HTTP error response.
///
/// One or more fields were not validated `PocketBase`.
#[error("One or more fields were not validated : {0:?}")]
BadRequest(Vec<BadRequestError>),
/// Communication with the `PocketBase` API was successful,
/// but returned a [403 Forbidden]("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403") HTTP error response.
///
/// The authorized record is not allowed to perform this action.
#[error("The authorized record is not allowed to perform this action.")]
Forbidden,
/// Communication with the `PocketBase` API was successful,
/// but returned a [404 Not Found]("https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404") HTTP error response.
///
/// The requested resource wasn't found. Missing collection context.
#[error("The requested resource wasn't found. Missing collection context.")]
NotFound,
/// Communication with the `PocketBase` API failed.
///
/// This could be caused by an internet outage, an error in the link given to the `PocketBase` SDK
/// and similar errors.
#[error("The communication with the PocketBase API failed: {0}")]
Unreachable(String),
/// The response could not be parsed into the expected data structure.
#[error("Could not parse response into the expected data structure. It usually means that there is a missmatch between the provided Generic Type Parameter and your Collection definition: {0}")]
ParseError(String),
/// The response from the `PocketBase` instance API was unexpected.
/// If you think its an error, please [open an issue on GitHub]("https://github.com/fromhorizons/pocketbase-rs/issues").
#[error("An unhandled status code was returned by the PocketBase API: {0}")]
UnexpectedResponse(String),
}
pub struct CollectionUpdateBuilder<'a, T: Send + Serialize + Deserialize<'a>> {
client: &'a PocketBase,
collection_name: &'a str,
record_id: &'a str,
data: T,
_marker: std::marker::PhantomData<T>,
}
#[derive(Deserialize, Clone, Debug)]
#[serde(rename_all = "camelCase")]
pub struct UpdateResponse {
pub collection_name: String,
pub collection_id: String,
pub id: String,
pub updated: String,
pub created: String,
}
impl<'a> Collection<'a> {
/// Update a single record.
///
/// On success, this function returns a [`UpdateResponse`] struct, otherwise returns a [`UpdateError`], which may include:
///
/// # Example
///
/// ```rust,ignore
/// use std::error::Error;
///
/// use pocketbase_rs::{AuthenticationError, PocketBaseAdminBuilder};
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Default, Serialize, Deserialize, Clone, Debug)]
/// pub struct Article {
/// name: String,
/// content: String,
/// }
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn Error>> {
/// let mut admin_pb = PocketBaseAdminBuilder::new("http://localhost:8081")
/// .auth_with_password("test@test.com", "abcdefghijkl")
/// .await?;
///
/// let updated_article = Article {
/// name: String::from("Updated Article Title"),
/// content: String::from("Updated article content"),
/// };
///
/// let request = admin_pb
/// .collection("articles")
/// .update::<Article>("jla0s0s86d83wx8", updated_article)
/// .await;
///
/// match request {
/// Ok(article) => println!("Ok: {:?}", article),
/// Err(error) => eprintln!("Error: {error}"),
/// }
///
/// Ok(())
/// }
/// ```
///
/// # Errors
///
/// This function will return an error if:
/// - The request to the server fails (`UpdateError::Unreachable`).
/// - The server responds with a bad request status (`UpdateError::BadRequest`).
/// - The server responds with a forbidden status (`UpdateError::Forbidden`).
/// - The record is not found (`UpdateError::NotFound`).
/// - The server responds with an unexpected status (`UpdateError::UnexpectedResponse`).
/// - The response could not be parsed into the expected data structure (`UpdateError::ParseError`).
pub async fn update<T: Default + Serialize + Clone + Send>(
self,
record_id: &'a str,
record: T,
) -> Result<UpdateResponse, UpdateError> {
let collection_name = self.name;
let endpoint = format!(
"{}/api/collections/{}/records/{}",
self.client.base_url, collection_name, record_id
);
let request = self
.client
.request_patch_json(&endpoint, &record)
.send()
.await;
match request {
Ok(response) => match response.status() {
reqwest::StatusCode::OK => {
let data = response.json::<UpdateResponse>().await;
match data {
Ok(data) => Ok(data),
Err(error) => Err(UpdateError::ParseError(error.to_string())),
}
}
reqwest::StatusCode::BAD_REQUEST => {
let data = response.json::<BadRequestResponse>().await;
match data {
Ok(bad_response) => {
let mut errors: Vec<BadRequestError> = vec![];
for (error_name, error_data) in bad_response.data {
errors.push(BadRequestError {
name: error_name,
code: error_data.code,
message: error_data.message,
});
}
Err(UpdateError::BadRequest(errors))
}
Err(error) => Err(UpdateError::ParseError(error.to_string())),
}
}
reqwest::StatusCode::FORBIDDEN => Err(UpdateError::Forbidden),
reqwest::StatusCode::NOT_FOUND => Err(UpdateError::NotFound),
_ => Err(UpdateError::UnexpectedResponse(
response.status().to_string(),
)),
},
Err(error) => Err(UpdateError::Unreachable(error.to_string())),
}
}
}