Skip to content
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.

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

Make read_event_into_async an async-fn #569

Merged
merged 6 commits into from
Mar 4, 2023
Merged

Conversation

vilunov
Copy link
Contributor

@vilunov vilunov commented Mar 2, 2023

Unless I'm missing something, this compiles and passes test just fine. Found out it while digging for the reason why my future suddenly becomes non-Send.

@vilunov
Copy link
Contributor Author

vilunov commented Mar 2, 2023

I realised that I forgot to enable the tokio feature-flag on my local copy. Tried to fix this stuff by rewriting it as a loop instead of recursion, it indeed infers the future as Sendable now. The alternative would be to duplicate a bunch of methods in Reader and NsReader, and I didn't really like it.

src/reader/async_tokio.rs Outdated Show resolved Hide resolved
@Mingun
Copy link
Collaborator

Mingun commented Mar 2, 2023

So again, what this PR does except changing the style of the method definition (which of course is great and I like it, but I want to understand if we need to add something valuable to the changelog)? Also, I would like to not duplicate actual realization. Is it possible to keep macro so we have only one place where parsing logic is located?

@codecov-commenter
Copy link

Codecov Report

Merging #569 (7b44722) into master (25dbd53) will increase coverage by 0.04%.
The diff coverage is 83.33%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##           master     #569      +/-   ##
==========================================
+ Coverage   63.26%   63.30%   +0.04%     
==========================================
  Files          33       33              
  Lines       16486    16526      +40     
==========================================
+ Hits        10430    10462      +32     
- Misses       6056     6064       +8     
Flag Coverage Δ
unittests 63.30% <83.33%> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/reader/async_tokio.rs 60.60% <83.33%> (+13.14%) ⬆️
src/de/mod.rs 70.64% <0.00%> (-0.17%) ⬇️
src/escapei.rs 13.42% <0.00%> (+0.17%) ⬆️
src/de/map.rs 83.93% <0.00%> (+0.51%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@vilunov
Copy link
Contributor Author

vilunov commented Mar 2, 2023

We are also making the resulting future Send if the writer is Send, which makes it possible to use the library with multithreaded runtime such as tokio, and this was my primary motivation.

Give me some time, I'll try to rewrite the macro. Also, this probably should be merged into the next 0.28 major release, as it breaks the public API.

@Mingun
Copy link
Collaborator

Mingun commented Mar 2, 2023

Yes, I think I want to see that in the 0.28 release.

Copy link
Collaborator

@Mingun Mingun left a comment

Choose a reason for hiding this comment

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

Good work! Please add an entry to Changelog.md. Each entry is started with an issue/PR number, the links are resolved in the end of chapter.

src/reader/async_tokio.rs Outdated Show resolved Hide resolved
src/reader/async_tokio.rs Outdated Show resolved Hide resolved
src/reader/mod.rs Outdated Show resolved Hide resolved
src/reader/mod.rs Outdated Show resolved Hide resolved
@Mingun Mingun merged commit b6e376b into tafia:master Mar 4, 2023
crapStone added a commit to Calciumdibromid/CaBr2 that referenced this pull request Mar 16, 2023
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [quick-xml](https://github.com/tafia/quick-xml) | dependencies | minor | `0.27.1` -> `0.28.0` |

---

### Release Notes

<details>
<summary>tafia/quick-xml</summary>

### [`v0.28.0`](https://github.com/tafia/quick-xml/blob/HEAD/Changelog.md#&#8203;0280----2023-03-13)

[Compare Source](tafia/quick-xml@v0.27.1...v0.28.0)

##### New Features

-   [#&#8203;541]: (De)serialize specially named `$text` enum variant in [externally tagged]
    enums to / from textual content
-   [#&#8203;556]: `to_writer` and `to_string` now accept `?Sized` types
-   [#&#8203;556]: Add new `to_writer_with_root` and `to_string_with_root` helper functions
-   [#&#8203;520]: Add methods `BytesText::inplace_trim_start` and `BytesText::inplace_trim_end`
    to trim leading and trailing spaces from text events
-   [#&#8203;565]: Allow deserialize special field names `$value` and `$text` into borrowed
    fields when use serde deserializer
-   [#&#8203;568]: Rename `Writter::inner` into `Writter::get_mut`
-   [#&#8203;568]: Add method `Writter::get_ref`
-   [#&#8203;569]: Rewrite the `Reader::read_event_into_async` as an async fn, making the future `Send` if possible.
-   [#&#8203;571]: Borrow element names (`<element>`) when deserialize with serde.
    This change allow to deserialize into `HashMap<&str, T>`, for example
-   [#&#8203;573]: Add basic support for async byte writers via tokio's `AsyncWrite`.

##### Bug Fixes

-   [#&#8203;537]: Restore ability to deserialize attributes that represents XML namespace
    mappings (`xmlns:xxx`) that was broken since [#&#8203;490]
-   [#&#8203;510]: Fix an error of deserialization of `Option<T>` fields where `T` is some
    sequence type (for example, `Vec` or tuple)
-   [#&#8203;540]: Fix a compilation error (probably a rustc bug) in some circumstances.
    `Serializer::new` and `Serializer::with_root` now accepts only references to `Write`r.
-   [#&#8203;520]: Merge consequent (delimited only by comments and processing instructions)
    texts and CDATA when deserialize using serde deserializer. `DeEvent::Text` and
    `DeEvent::CData` events was replaced by `DeEvent::Text` with merged content.
    The same behavior for the `Reader` does not implemented (yet?) and should be
    implemented manually
-   [#&#8203;562]: Correctly set minimum required version of memchr dependency to 2.1
-   [#&#8203;565]: Correctly set minimum required version of tokio dependency to 1.10
-   [#&#8203;565]: Fix compilation error when build with serde <1.0.139

[externally tagged]: https://serde.rs/enum-representations.html#externally-tagged

[#&#8203;490]: tafia/quick-xml#490

[#&#8203;510]: tafia/quick-xml#510

[#&#8203;520]: tafia/quick-xml#520

[#&#8203;537]: tafia/quick-xml#537

[#&#8203;540]: tafia/quick-xml#540

[#&#8203;541]: tafia/quick-xml#541

[#&#8203;556]: tafia/quick-xml#556

[#&#8203;562]: tafia/quick-xml#562

[#&#8203;565]: tafia/quick-xml#565

[#&#8203;568]: tafia/quick-xml#568

[#&#8203;569]: tafia/quick-xml#569

[#&#8203;571]: tafia/quick-xml#571

[#&#8203;573]: tafia/quick-xml#573

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS42LjAiLCJ1cGRhdGVkSW5WZXIiOiIzNS42LjAifQ==-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Co-authored-by: crapStone <crapstone01@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1818
Reviewed-by: crapStone <crapstone@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants