Skip to content

refactor(rust): shrink uniform API call errors #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamcavendish merged 1 commit into from
Aug 8, 2026
Merged

refactor(rust): shrink uniform API call errors #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- Store the private representation of generated Rust `ApiCallError` values behind
a `Box`, making the common erased error pointer-sized. Derived `Debug` output now
reflects the private inner wrapper.

## [0.2.1]

### Breaking Changes
Expand Down
134 changes: 111 additions & 23 deletions src/generators/rust/common/runtime.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ pub(crate) fn render_api_call_error(
FileSpec::builder("error.rs")
.add_type(api_call_http_error(response_headers_type.clone())?)
.add_type(api_call_error_kind()?)
.add_type(api_call_error_inner()?)
.add_type(api_call_error(response_headers_type)?)
.add_code(api_call_error_display()?)
.add_code(api_call_error_source()?)
Expand Down Expand Up @@ -83,6 +84,56 @@ fn api_call_error_kind() -> Result<TypeSpec, SigilStitchError> {
.build()
}

fn api_call_error_inner() -> Result<TypeSpec, SigilStitchError> {
let api_error_of_t = TypeName::generic(
TypeName::primitive("ApiError"),
vec![TypeName::primitive("T")],
);
let from_api_error = FunSpec::builder("from_api_error")
.add_type_param(TypeParamSpec::new("T"))
.add_param(ParameterSpec::of("operation_id", operation_id_type()))
.add_param(ParameterSpec::of("error", api_error_of_t))
.returns(TypeName::primitive("Self"))
.body(
sigil_quote!(RustLang {
Self {
operation_id,
kind: ApiCallErrorKind::Http(ApiCallHttpError::from_api_error(error)),
}
})
.map_err(|error| SigilStitchError::Render {
context: "ApiCallErrorInner::from_api_error body".into(),
message: error.to_string(),
})?,
)
.build()?;
let from_runtime_error = FunSpec::builder("from_runtime_error")
.add_param(ParameterSpec::of("operation_id", operation_id_type()))
.add_param(ParameterSpec::of("error", TypeName::primitive("Error")))
.returns(TypeName::primitive("Self"))
.body(
sigil_quote!(RustLang {
Self {
operation_id,
kind: ApiCallErrorKind::Runtime(error),
}
})
.map_err(|error| SigilStitchError::Render {
context: "ApiCallErrorInner::from_runtime_error body".into(),
message: error.to_string(),
})?,
)
.build()?;

TypeSpec::builder("ApiCallErrorInner", TypeKind::Struct)
.annotate(AnnotationSpec::new("derive").args(["Debug"]))
.add_field(FieldSpec::builder("operation_id", operation_id_type()).build()?)
.add_field(FieldSpec::builder("kind", TypeName::primitive("ApiCallErrorKind")).build()?)
.add_method(from_api_error)
.add_method(from_runtime_error)
.build()
}

fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStitchError> {
let static_str = operation_id_type();
let api_error_of_t = TypeName::generic(
Expand All @@ -99,24 +150,34 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
.add_param(ParameterSpec::of("operation_id", static_str.clone()))
.add_param(ParameterSpec::of("error", api_error_of_t))
.returns(TypeName::primitive("Self"))
.body(sigil_quote!(RustLang {
Self {
operation_id,
kind: ApiCallErrorKind::Http(ApiCallHttpError::from_api_error(error)),
}
})?)
.body(
sigil_quote!(RustLang {
Self {
inner: Box::new(ApiCallErrorInner::from_api_error(operation_id, error)),
}
})
.map_err(|error| SigilStitchError::Render {
context: "ApiCallError::from_api_error body".into(),
message: error.to_string(),
})?,
)
.build()?;
let from_runtime_error = FunSpec::builder("from_runtime_error")
.visibility(Visibility::PublicCrate)
.add_param(ParameterSpec::of("operation_id", static_str.clone()))
.add_param(ParameterSpec::of("error", TypeName::primitive("Error")))
.returns(TypeName::primitive("Self"))
.body(sigil_quote!(RustLang {
Self {
operation_id,
kind: ApiCallErrorKind::Runtime(error),
}
})?)
.body(
sigil_quote!(RustLang {
Self {
inner: Box::new(ApiCallErrorInner::from_runtime_error(operation_id, error)),
}
})
.map_err(|error| SigilStitchError::Render {
context: "ApiCallError::from_runtime_error body".into(),
message: error.to_string(),
})?,
)
.build()?;
let operation_id = FunSpec::builder("operation_id")
.visibility(Visibility::Public)
Expand All @@ -125,7 +186,7 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
)
.add_param(ParameterSpec::of("&self", TypeName::primitive("")))
.returns(static_str)
.body(sigil_quote!(RustLang { self.operation_id })?)
.body(sigil_quote!(RustLang { self.inner.operation_id })?)
.build()?;
let status_code = FunSpec::builder("status_code")
.visibility(Visibility::Public)
Expand All @@ -134,7 +195,7 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
.returns(optional_status)
.body(
sigil_quote!(RustLang {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(error.status_code),
ApiCallErrorKind::Runtime(_) => None,
}
Expand All @@ -147,7 +208,7 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
.add_param(ParameterSpec::of("&self", TypeName::primitive("")))
.returns(optional_headers)
.body(sigil_quote!(RustLang {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(&error.headers),
ApiCallErrorKind::Runtime(_) => None,
}
Expand All @@ -159,7 +220,7 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
.add_param(ParameterSpec::of("&self", TypeName::primitive("")))
.returns(optional_body)
.body(sigil_quote!(RustLang {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(&error.raw_body),
ApiCallErrorKind::Runtime(_) => None,
}
Expand All @@ -170,8 +231,7 @@ fn api_call_error(response_headers_type: TypeName) -> Result<TypeSpec, SigilStit
.visibility(Visibility::Public)
.doc("Type-erased error from any generated API operation.")
.annotate(AnnotationSpec::new("derive").args(["Debug"]))
.add_field(FieldSpec::builder("operation_id", operation_id_type()).build()?)
.add_field(FieldSpec::builder("kind", TypeName::primitive("ApiCallErrorKind")).build()?)
.add_field(FieldSpec::builder("inner", api_call_error_inner_type()).build()?)
.add_method(from_api_error)
.add_method(from_runtime_error)
.add_method(operation_id)
Expand All @@ -185,6 +245,13 @@ fn operation_id_type() -> TypeName {
TypeName::reference_with_lifetime(TypeName::primitive("str"), "'static")
}

fn api_call_error_inner_type() -> TypeName {
TypeName::generic(
TypeName::primitive("Box"),
vec![TypeName::primitive("ApiCallErrorInner")],
)
}

fn api_call_headers_type(response_headers_type: TypeName) -> TypeName {
TypeName::optional(TypeName::reference(response_headers_type))
}
Expand All @@ -197,12 +264,12 @@ fn api_call_error_display() -> Result<CodeBlock, SigilStitchError> {
sigil_quote!(RustLang {
impl std::fmt::Display for ApiCallError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => {
write!(f, "operation {} failed with HTTP status {}", self.operation_id, error.status_code)
write!(f, "operation {} failed with HTTP status {}", self.inner.operation_id, error.status_code)
}
ApiCallErrorKind::Runtime(error) => {
write!(f, "operation {} failed: {error}", self.operation_id)
write!(f, "operation {} failed: {error}", self.inner.operation_id)
}
}
}
Expand All @@ -214,12 +281,12 @@ fn api_call_error_source() -> Result<CodeBlock, SigilStitchError> {
sigil_quote!(RustLang {
impl std::error::Error for ApiCallError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
if let ApiCallErrorKind::Http(error) = &self.kind {
if let ApiCallErrorKind::Http(error) = &self.inner.kind {
if let Some(error) = &error.body_error {
return Some(error);
}
}
if let ApiCallErrorKind::Runtime(error) = &self.kind {
if let ApiCallErrorKind::Runtime(error) = &self.inner.kind {
return Some(error);
}
None
Expand Down Expand Up @@ -256,6 +323,27 @@ mod tests {
r#"fn inspect(operation_id: &'static str) -> (Option<&reqwest::header::HeaderMap>, Option<&[u8]>) {
todo!()
}
"#,
);
}

#[test]
fn api_call_error_owned_type_renders_exactly() {
let inner = api_call_error_inner_type();
let block = sigil_quote!(RustLang {
struct ApiCallError {
inner: $T(inner),
}
})
.expect("ApiCallError owned type probe builds");

assert_rendered!(
Rust::new(),
width = 100,
block,
r#"struct ApiCallError {
inner: Box<ApiCallErrorInner>,
}
"#,
);
}
Expand Down
47 changes: 33 additions & 14 deletions tests/golden/rust/rust-aioduct/additional-properties/src/runtime/error.rs.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,52 +131,71 @@ enum ApiCallErrorKind {
Runtime(Error),
}

/// Type-erased error from any generated API operation.
#[derive(Debug)]
pub struct ApiCallError {
struct ApiCallErrorInner {
operation_id: &'static str,
kind: ApiCallErrorKind,
}

impl ApiCallError {
pub(crate) fn from_api_error<T>(operation_id: &'static str, error: ApiError<T>) -> Self {
impl ApiCallErrorInner {
fn from_api_error<T>(operation_id: &'static str, error: ApiError<T>) -> Self {
Self {
operation_id,
kind: ApiCallErrorKind::Http(ApiCallHttpError::from_api_error(error)),
}
}

pub(crate) fn from_runtime_error(operation_id: &'static str, error: Error) -> Self {
fn from_runtime_error(operation_id: &'static str, error: Error) -> Self {
Self {
operation_id,
kind: ApiCallErrorKind::Runtime(error),
}
}
}

/// Type-erased error from any generated API operation.
#[derive(Debug)]
pub struct ApiCallError {
inner: Box<ApiCallErrorInner>,
}

impl ApiCallError {
pub(crate) fn from_api_error<T>(operation_id: &'static str, error: ApiError<T>) -> Self {
Self {
inner: Box::new(ApiCallErrorInner::from_api_error(operation_id, error)),
}
}

pub(crate) fn from_runtime_error(operation_id: &'static str, error: Error) -> Self {
Self {
inner: Box::new(ApiCallErrorInner::from_runtime_error(operation_id, error)),
}
}

/// Operation identifier, generated from the HTTP method and path when OpenAPI omits one.
pub fn operation_id(&self) -> &'static str {
self.operation_id
self.inner.operation_id
}

/// HTTP response status, if the operation reached the server and received an error response.
pub fn status_code(&self) -> Option<u16> {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(error.status_code),
ApiCallErrorKind::Runtime(_) => None,
}
}

/// Native HTTP response headers, if an error response was received.
pub fn headers(&self) -> Option<&aioduct::HeaderMap> {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(&error.headers),
ApiCallErrorKind::Runtime(_) => None,
}
}

/// Raw HTTP response body, if an error response was received.
pub fn raw_body(&self) -> Option<&[u8]> {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => Some(&error.raw_body),
ApiCallErrorKind::Runtime(_) => None,
}
Expand All @@ -185,25 +204,25 @@ impl ApiCallError {

impl std::fmt::Display for ApiCallError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match &self.kind {
match &self.inner.kind {
ApiCallErrorKind::Http(error) => {
write!(f, "operation {} failed with HTTP status {}", self.operation_id, error.status_code)
write!(f, "operation {} failed with HTTP status {}", self.inner.operation_id, error.status_code)
}
ApiCallErrorKind::Runtime(error) => {
write!(f, "operation {} failed: {error}", self.operation_id)
write!(f, "operation {} failed: {error}", self.inner.operation_id)
}
}
}
}

impl std::error::Error for ApiCallError {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
if let ApiCallErrorKind::Http(error) = &self.kind {
if let ApiCallErrorKind::Http(error) = &self.inner.kind {
if let Some(error) = &error.body_error {
return Some(error);
}
}
if let ApiCallErrorKind::Runtime(error) = &self.kind {
if let ApiCallErrorKind::Runtime(error) = &self.inner.kind {
return Some(error);
}
None
Expand Down
Loading
Loading