Skip to content

Improve deprecation messages in events/attributes.rs #1016

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

Open
xkr47 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve deprecation messages in events/attributes.rs #1016

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
20 changes: 12 additions & 8 deletions src/events/attributes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,8 @@ impl<'a> Attribute<'a> {
///
/// # Deprecation
///
/// Use [`normalized_value()`](Self::normalized_value) instead.
/// Use [`normalized_value()`](Self::normalized_value) instead with
/// argument `XmlVersion::Implicit1_0`.
///
/// Escape sequences such as `&gt;` are replaced with their unescaped
/// equivalents such as `>`.
Expand All @@ -260,7 +261,7 @@ impl<'a> Attribute<'a> {
///
/// [`encoding`]: ../../index.html#encoding
#[cfg(any(doc, not(feature = "encoding")))]
#[deprecated = "use `Self::normalized_value()`"]
#[deprecated = "use `Self::normalized_value(XmlVersion::Implicit1_0)`"]

@dralley dralley Sep 7, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Strictly speaking the value you use here might depend on the actual XML version of the document - 1.0 is certainly the most common, and for many known documents the user may not need to check, but they probably should.

@dralley dralley Sep 7, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least in the case of unescaping events though, I'm working on some changes to EOL normalization that ought to make it unnecessary.

pub fn unescape_value(&self) -> XmlResult<Cow<'a, str>> {
// resolve_predefined_entity returns only non-recursive replacements, so depth=1 is enough
self.normalized_value_with(XmlVersion::Implicit1_0, 1, resolve_predefined_entity)
Expand All @@ -270,7 +271,8 @@ impl<'a> Attribute<'a> {
///
/// # Deprecation
///
/// Use [`normalized_value_with()`](Self::normalized_value_with) instead.
/// Use [`normalized_value_with()`](Self::normalized_value_with) instead
/// with parameters with arguments `XmlVersion::Implicit1_0` and `128`.
///
/// Escape sequences such as `&gt;` are replaced with their unescaped
/// equivalents such as `>`. A fallback resolver for additional custom
Expand All @@ -282,7 +284,7 @@ impl<'a> Attribute<'a> {
///
/// [`encoding`]: ../../index.html#encoding
#[cfg(any(doc, not(feature = "encoding")))]
#[deprecated = "use `Self::normalized_value_with()`"]
#[deprecated = "use `Self::normalized_value_with(XmlVersion::Implicit1_0, 128, resolve_entity)`"]
#[inline]
pub fn unescape_value_with<'entity>(
&self,
Expand All @@ -296,10 +298,11 @@ impl<'a> Attribute<'a> {
/// # Deprecation
///
/// Attribute values are now always stored as valid UTF-8 strings, so decoding
/// is no longer needed. Use [`normalized_value()`](Self::normalized_value) instead.
/// is no longer needed. Use [`normalized_value()`](Self::normalized_value)
/// instead with argument `XmlVersion::Implicit1_0`.
///
/// This will allocate if the value contains any escape sequences.
#[deprecated = "decoding is no longer needed, use `Self::normalized_value()` instead"]
#[deprecated = "decoding is no longer needed, use `Self::normalized_value(XmlVersion::Implicit1_0)` instead"]
#[inline]
pub fn decode_and_unescape_value(&self, _decoder: Decoder) -> XmlResult<Cow<'a, str>> {
self.normalized_value(XmlVersion::Implicit1_0)
Expand All @@ -310,10 +313,11 @@ impl<'a> Attribute<'a> {
/// # Deprecation
///
/// Attribute values are now always stored as valid UTF-8 strings, so decoding
/// is no longer needed. Use [`normalized_value_with()`](Self::normalized_value_with) instead.
/// is no longer needed. Use [`normalized_value_with()`](Self::normalized_value_with)
/// instead with arguments `XmlVersion::Implicit1_0` and `128`.
///
/// This will allocate if the value contains any escape sequences.
#[deprecated = "decoding is no longer needed, use `Self::normalized_value_with()` instead"]
#[deprecated = "decoding is no longer needed, use `Self::normalized_value_with(XmlVersion::Implicit1_0, 128, resolve_entity)` instead"]
#[inline]
pub fn decode_and_unescape_value_with<'entity>(
&self,
Expand Down
Loading