André Cipriani Bandarra
c4acf465ba
Document all public structs, enums, traits, functions, fields, and variants across the library. Adds crate-level documentation with a usage example, module-level docs, and API reference links where applicable. Also fixes four bare URL warnings in existing doc comments.
104 lines
3.0 KiB
Rust
104 lines
3.0 KiB
Rust
//! Error types for the Google Gemini client.
|
|
|
|
use std::fmt::Display;
|
|
use tokio_util::codec::LinesCodecError;
|
|
|
|
use crate::types;
|
|
|
|
/// A type alias for `Result<T, error::Error>`.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// Errors that can occur when using the Gemini client.
|
|
#[derive(Debug)]
|
|
pub enum Error {
|
|
/// An environment variable required for configuration was missing or invalid.
|
|
Env(std::env::VarError),
|
|
/// An HTTP transport error from the underlying `reqwest` client.
|
|
HttpClient(reqwest::Error),
|
|
/// A JSON serialization or deserialization error.
|
|
Serde(serde_json::Error),
|
|
/// A structured error returned by the Vertex AI API.
|
|
VertexError(types::VertexApiError),
|
|
/// A structured error returned by the Gemini API.
|
|
GeminiError(types::GeminiApiError),
|
|
/// The API response contained no candidate completions.
|
|
NoCandidatesError,
|
|
/// An error occurred while decoding the SSE event stream.
|
|
EventSourceError(LinesCodecError),
|
|
/// The SSE event stream closed unexpectedly.
|
|
EventSourceClosedError,
|
|
/// An API error that could not be parsed into a structured error type.
|
|
GenericApiError {
|
|
/// The HTTP status code.
|
|
status: u16,
|
|
/// The raw response body.
|
|
body: String,
|
|
},
|
|
}
|
|
|
|
impl Display for Error {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
match &self {
|
|
Error::Env(e) => write!(f, "Environment variable error: {e}"),
|
|
Error::HttpClient(e) => write!(f, "HTTP Client error: {e}"),
|
|
Error::Serde(e) => write!(f, "Serde error: {e}"),
|
|
Error::VertexError(e) => {
|
|
write!(f, "Vertex error: {e}")
|
|
}
|
|
Error::GeminiError(e) => {
|
|
write!(f, "Gemini error: {e}")
|
|
}
|
|
Error::NoCandidatesError => {
|
|
write!(f, "No candidates returned for the prompt")
|
|
}
|
|
Error::EventSourceError(e) => {
|
|
write!(f, "EventSource Error: {e}")
|
|
}
|
|
Error::EventSourceClosedError => {
|
|
write!(f, "EventSource closed error")
|
|
}
|
|
Error::GenericApiError { status, body } => {
|
|
write!(f, "API error (status {status}): {body}")
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for Error {}
|
|
|
|
impl From<reqwest::Error> for Error {
|
|
fn from(e: reqwest::Error) -> Self {
|
|
Error::HttpClient(e)
|
|
}
|
|
}
|
|
|
|
impl From<std::env::VarError> for Error {
|
|
fn from(e: std::env::VarError) -> Self {
|
|
Error::Env(e)
|
|
}
|
|
}
|
|
|
|
impl From<serde_json::Error> for Error {
|
|
fn from(e: serde_json::Error) -> Self {
|
|
Error::Serde(e)
|
|
}
|
|
}
|
|
|
|
impl From<types::VertexApiError> for Error {
|
|
fn from(e: types::VertexApiError) -> Self {
|
|
Error::VertexError(e)
|
|
}
|
|
}
|
|
|
|
impl From<types::GeminiApiError> for Error {
|
|
fn from(e: types::GeminiApiError) -> Self {
|
|
Error::GeminiError(e)
|
|
}
|
|
}
|
|
|
|
impl From<LinesCodecError> for Error {
|
|
fn from(e: LinesCodecError) -> Self {
|
|
Error::EventSourceError(e)
|
|
}
|
|
}
|