CHANGELOG.md

Release 0.7.0

This release includes a simplified client API that removes the unnecessary indirection caused by the Call struct, in addition to some notable dependency updates (hyper v1) that are part of the public API.

Major dependency updates:

• axum v0.6 → v0.7
• base64 v0.21 → v0.22
• hyper v0.14 → v1
• proc-macro-crate v1 → v3
• quick-xml v0.30 → 0.37
• reqwest v0.11 → v0.12

Release 0.6.3

This release contains a fix for a compilation failure when using the derive macros for TryToValue and TryFromValue and a custom Result type is in scope.

The oldest supported Rust version was bumped to 1.70.0 to match crate dependencies.

Release 0.6.2

This release introduces support for serializing / deserializing XML-RPC structs that have members with names that are reserved keywords in Rust (using the standard raw identifier syntax).

The oldest supported Rust version was bumped to 1.67.0 to match the time crate.

Release 0.6.1

This release slightly improves interoperability with other XML-RPC implementations. Some implementations line-wrap base64-encoded strings in the <base64> type, which is now supported. Previous releases of dxr rejected base64 values that included any whitespace.

Release 0.6.0

This release includes changes from v0.6.0-beta.1 and v0.6.0-beta.2.

Internal changes:

This version introduces new helper functions for serializing and deserializing XML in an effort to produce consistent output that is compatible with the widest range of other XML-RPC implementations (some of which don't support self-closing XML tags).

Notably, quick-xml versions before 0.27 produced self-closing tags only in some circumstances (like <nil/> values), but not others (like empty string values: <value><string></string></value>). Versions 0.27 and newer fixed this issue by consistently writing self-closing tags. Version 0.30 added a custom deserializer setting to expand these tags instead of writing self-closing tags, which is what the newly introduced helper function uses.

Updated:

• quick-xml dependency was updated from v0.25 to v0.30.

Release 0.6.0-beta.2

Changed:

• A custom PartialEq implementation for <struct> was added, which now properly ignores the order of struct members.
• The number of closures was reduced by replacing with plain functions, where possible.
• The implementation of TryFromValue and TryToValue for Cow<'a, T> was fixed for T = str, which previously was not covered.

Internal changes:

• The script for generating the test coverage report now also runs the example binaries.
• The test suite is now much more comprehensive, resulting in >95% test coverage for the dxr crate.

Release 0.6.0-beta.1

The relationship between the crates in this project has been simplified. The top-level meta-crate was removed, and the axum support was merged into the dxr_server crate and hidden behind a feature flag. Additionally, the dxr_client and dxr_server crates have been refactored to support different HTTP libraries (though only reqwest and axum are currently supported).

Changed:

• Functions in the dxr_client and dxr_server crates that can fail now return concrete error types instead of a generic anyhow::Error.
• Initialization of servers in dxr_server was refactored to avoid calling APIs that can panic.
• The dateTime.iso8601 XML-RPC type is now represented by chrono::NaiveDateTime to better match semantics of XML-RPC, where this type is explicitly timezone-unaware.
• The Value::string() constructor for <string> values now takes an owned String instead of a &str slice and immediately converting to an owned String internally.

Added:

• TryFromValue and TryToValue are now implemented for Arc<T> and Rc<T> for all inner types T which already implement these traits.
• Support and helper functionality for the system.multicall extension was implemented in both dxr_client and dxr_server and can be enabled with the multicall feature.

Fixed:

• XML-RPC values without an explicit type are now correctly deserialized as strings.

Updated:

• axum dependency was updated from v0.5 to v0.6.
• base64 dependency was updated from v0.13 to v0.21.
• quick-xml dependency was updated from v0.25 to v0.26.
• syn dependency was updated from v1 to v2.

Release 0.5.4

This release includes a fix for string-typed values, which were previously accidentally escaped (and unescaped) twice, resulting in XML that wasn't compatible with other XML-RPC implementations.

Release 0.5.3

This release adds feature flags for selecting a non-default TLS backend for reqwest in dxr_client. There should be no change to the default behaviour (the default-tls feature of reqwest). To use a different TLS backend (i.e. rustls), use dxr with default-features = false and enable the client-rustls-tls feature.

Release 0.5.2

This is a small release that brings only internal clean-ups with no user-facing code changes. Documentation as rendered on https://docs.rs/dxr should be slightly improved.

Release 0.5.1

Changed:

The Call.as_xml_rpc method is now pub instead of only pub(crate). This makes implementing third-party clients based on dxr (i.e. clients not based on reqwest) easier, and is a first step towards making the client functionality modular, similar to the server support.

Release 0.5.0

Changed:

All public traits were renamed to match Rust conventions for conversions ("try" prefix for fallible conversions, "to" for conversions that don't take ownership):

• FromParams was renamed to TryFromParams
• FromDXR was renamed to TryFromValue
• ToParams was renamed to TryToParams
• ToDXR was renamed to TryToValue

This change only affects code which referenced these traits directly, or via derive macros.

Updated dependencies:

The quick-xml dependency was updated from 0.23 to the latest version, 0.25, resulting in two user-visible changes in dxr:

The fallible Value::string_escape constructor was removed and replaced by an infallible Value::string constructor, following API changes of quick_xml::escape::escape with version 0.24 and later.

The Minimum Supported Rust Version (MSRV) was bumped from 1.60.0 to 1.61.0 (caused by the update to quick-xml version >= 0.24.0, though it might be possible to revert to 1.60.0 again with a future version of quick-xml, since this MSRV bump seems to have been unintentional).

Release 0.4.0

Changed:

• moved implementations of XML-RPC clients, servers, and the axum server support into separate crates, available as optional features of the top-level dxr crate
• moved to more powerful cargo feature syntax for optional and conditional dependencies
• server: refactored method call Handler trait to allow the handler function to be async

Fixed:

• methodResponse must apparently always contain exactly one value
• methodParameters contain an array of parameters that contain values, not a parameter that is an array of values

Both these fixes required minor changes to the public API, which is why they cannot be backported to the 0.3.x branch.

Added:

• implemented of FromDXR for fixed-size arrays
• implemented support for struct fields that are fixed-size arrays in the derive macros

Updated dependencies:

• updated axum version from 0.4 to 0.5
• updated quick_xml version from 0.22 to 0.23

Release 0.3.1

Fixed:

• fixed re-export of async-trait if axum-server feature is not enabled 😫

Release 0.3.0

Added:

• implementations of ToDXR and FromDXR for Box<T> (making owned recursive types possible)
• support for deriving ToDXR for structs containing &T references as fields (making reference-based recursive types possible)

Changed:

• merged code from the dxr_shared crate into the main dxr crate
• removed support for non-standard i8 and nil values from default features
• split server feature into generic server functionality and axum support
• use anyhow to simplify error handling in client and server implementations
• conversion from FaultResponse to Fault can fail, so implement a fallible TryFrom instead of a panicking From

Internal changes:

• added trybuild based pass/fail tests for derive macros

Release 0.2.1

Added:

• ServerBuilder method for changing the default route of the XML-RPC endpoint (default: /)

Internal changes:

• simplified / refactored Server::serve by splitting off the XML-RPC endpoint handler

Release 0.2.0

This version contains some fixes that required changes in public APIs (listed below), so this is a semver-incompatible release.

Added:

• convenience methods for checking the type of DxrError and extracting the inner error value
• more client-server roundtrip tests (for ~80% test coverage across all three crates)
• support for implementing / requesting graceful server shutdown
• snapshot tests for some Debug implementations
• feature hints for the generated documentation on docs.rs

Changed:

• moved method handler synchronization from the server to the method handlers themselves to improve concurrency, throughput and latency, especially for methods that do not modify internal or global state
• changed MethodResponse to match the XML-RPC spec (<params> can be missing)
• changed method signatures on client and server implementations to adapt to optional return values
• renamed DxrError::ReturnMismatch to DxrError::ParameterMismatch to better reflect what it actually means (unexpected number of parameters, whether they are method call arguments or return values)

Release 0.1.1

This version fixes some minor issues that were discovered since the last release.

Added:

• added some client-server roundtrip tests using a simple echo server implementation (in dxr/tests/echo.rs)

Fixed:

• fixed infinite recursion in (T,) call parameter serialization
• make sure Call values can be sent across threads
• cleaned up minor formatting issues in docs and doctests
• fixed README.md badge links in the dxr_shared crate

Release 0.1.0

Initial release.