Whitespaces around character entities

オープン
  • 何か問題がありますか？
#900 コメント 3 件 リアクション 2 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
rust
領域
backend

調査の方向性

Start by reading the Config::trim_text behavior and the deserializer path that handles text and decoded character entities; the report includes a reproducer using NsReader and quick_xml::de::Deserializer::borrowing. Check existing tests for trimming and entity decoding, then determine whether a configuration option can preserve spaces around entities while trimming only leading and trailing text. Done means the reproducer retains those internal spaces without losing global edge trimming.

索引モデルが issue の本文から書いたものです。

説明

help wanted serde

I maintain a large codebase that used quick-xml for years across hundreds of structs.

After switching from 0.37.5 to 0.38, I hit the already well-known whitespace issues. 0.38.1 introduced Config::trim_text which saved me from touching thousands of fields, but now I found the next caveat: XML character entities make trim_text(true) trim more than needed:

#!/usr/bin/env cargo
---
[dependencies]
serde = { version = "1", features = ["derive"] }
quick-xml = { version = "0.38", features = ["serialize"] }
quick-xml-old = { package = "quick-xml", version = "0.37", features = ["serialize"] }
---

use quick_xml::reader::NsReader;
use serde::Deserialize;
use std::result::Result;

#[derive(Debug, Deserialize)]
struct Root {
    bar: String,
}

pub fn from_str_trim_text<'de, T>(s: &'de str) -> Result<T, Box<dyn std::error::Error>>
where
    T: Deserialize<'de>,
{
    let mut reader = NsReader::from_str(s);
    let config = reader.config_mut();

    config.trim_text(true); // Trims also spaces around decoded &amp;
    config.expand_empty_elements = true;

    let mut de = quick_xml::de::Deserializer::borrowing(reader);
    Ok(T::deserialize(&mut de)?)
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let xml = r#"
    <root>
        <bar>
            Foo &amp; Bar  &amp;  Baz Qux   Quux
        </bar>
    </root>"#;

    let old: Root = quick_xml_old::de::from_str(xml)?;
    let new: Root = quick_xml::de::from_str(xml)?;
    let new_trimming: Root = from_str_trim_text(xml)?;

    println!("Old: {}", old.bar); // "Foo & Bar  &  Baz Qux   Quux"
    println!("New: {}", new.bar); // "\n            Foo & Bar  &  Baz Qux   Quux\n        "
    println!("New trimming: {}", new_trimming.bar); // "Foo&Bar&Baz Qux   Quux"

    Ok(())
}

(cargo +nightly -Zscript example.rs)

I know this is documented behavior (thank you), so I'm not calling it a bug. I’m looking for a solution to preserve "internal" spaces (e.g, around the decoded entities) while still trimming leading/trailing whitespace globally.

The only workaround that comes to my mind atm is either introducing a newtype or using deserialize_with, which are both rather error-prone in a mature codebase like mine and require tons of work.

If there is no existing solution right now, I could try to implement a feature (e.g., a new config option?) if the maintainers think it is a good idea.

主要言語
Rust
スター
1.6k
フォーク
299
平均マージ
2日 4時間
マージ済み PR（30日）
9

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

tafia/quick-xml のほかの issue

tafia/quick-xml の issue をすべて見る

似ている issue

Rust の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。