baserow-rs 2.0.5

A Rust client for the Baserow API.
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

use tracing::{error, warn};

/// Errors that can occur during token-based authentication
///
/// These errors represent failures that may occur when attempting to
/// authenticate using API tokens or JWT tokens.
///
/// # Example
/// ```no_run
/// use baserow_rs::{ConfigBuilder, Baserow, error::TokenAuthError, api::client::BaserowClient};
///
/// #[tokio::main]
/// async fn main() {
///     let config = ConfigBuilder::new()
///         .base_url("https://api.baserow.io")
///         .email("user@example.com")
///         .password("password")
///         .build();
///
///     let baserow = Baserow::with_configuration(config);
///     match baserow.token_auth().await {
///         Ok(client) => println!("Authentication successful"),
///         Err(TokenAuthError::MissingCredentials(field)) => {
///             println!("Missing required field: {}", field)
///         }
///         Err(e) => println!("Authentication failed: {}", e),
///     }
/// }
/// ```
#[derive(Debug, thiserror::Error)]
pub enum TokenAuthError {
    #[error("Authentication failed: Missing required {0} credentials")]
    MissingCredentials(&'static str),
    #[error("Token authentication failed: {0}")]
    AuthenticationFailed(String),
    #[error("Network error during authentication: {0}")]
    NetworkError(#[from] reqwest::Error),
}

impl TokenAuthError {
    pub(crate) fn log(&self) {
        match self {
            Self::MissingCredentials(field) => {
                warn!(error = %self, field = %field, "Token authentication failed due to missing credentials");
            }
            Self::AuthenticationFailed(msg) => {
                error!(error = %self, details = %msg, "Token authentication failed");
            }
            Self::NetworkError(e) => {
                error!(error = %self, network_error = %e, "Token authentication failed due to network error");
            }
        }
    }
}

/// Errors that can occur during file uploads
///
/// These errors represent various failures that may occur when
/// uploading files to Baserow, either directly or via URL.
///
/// # Example
/// ```no_run
/// use baserow_rs::{ConfigBuilder, Baserow, error::FileUploadError, api::client::BaserowClient};
/// use std::fs::File;
///
/// #[tokio::main]
/// async fn main() {
///     let config = ConfigBuilder::new()
///         .base_url("https://api.baserow.io")
///         .api_key("your-api-key")
///         .build();
///
///     let baserow = Baserow::with_configuration(config);
///     let file = File::open("image.jpg").unwrap();
///
///     match baserow.upload_file(file, "image.jpg".to_string()).await {
///         Ok(uploaded) => println!("File uploaded: {}", uploaded.url),
///         Err(FileUploadError::FileReadError(e)) => {
///             println!("Failed to read file: {}", e)
///         }
///         Err(e) => println!("Upload failed: {}", e),
///     }
/// }
/// ```
#[derive(Debug, thiserror::Error)]
pub enum FileUploadError {
    #[error("File upload failed: Unable to read file - {0}")]
    FileReadError(#[from] std::io::Error),
    #[error("File upload failed: Network error - {0}")]
    UploadError(#[from] reqwest::Error),
    #[error("File upload failed: Invalid content type provided")]
    InvalidContentType,
    #[error("File upload failed: Server responded with unexpected status code {0}")]
    UnexpectedStatusCode(reqwest::StatusCode),
    #[error("File upload failed: Invalid URL provided - {0}")]
    InvalidURL(String),
}

impl FileUploadError {
    pub(crate) fn log(&self) {
        match self {
            Self::FileReadError(e) => {
                error!(error = %self, io_error = %e, "File upload failed due to file read error");
            }
            Self::UploadError(e) => {
                error!(error = %self, network_error = %e, "File upload failed due to network error");
            }
            Self::InvalidContentType => {
                warn!(error = %self, "File upload failed due to invalid content type");
            }
            Self::UnexpectedStatusCode(status) => {
                error!(error = %self, status_code = %status, "File upload failed with unexpected status code");
            }
            Self::InvalidURL(url) => {
                warn!(error = %self, url = %url, "File upload failed due to invalid URL");
            }
        }
    }
}