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

Implement Clone for error enums #521

Merged
merged 3 commits into from
Dec 8, 2022
Merged

Conversation

zeenix
Copy link
Contributor

@zeenix zeenix commented Dec 6, 2022

This would allow using crates to embed errors from this crate into their error types that implement Clone.

Unfortunately std::io::Error does not implement Clone so we've to loose some of its state during cloning. The most importat bit (error kind) is preserved though.

@Mingun
Copy link
Collaborator

Mingun commented Dec 6, 2022

Cloneable errors seems not in a trend in Rust, it is unknown what the long-term consequences of this. I'm not totally against this PR, but I would like to hear what the situations where you need to clone errors?

@zeenix
Copy link
Contributor Author

zeenix commented Dec 6, 2022

Cloneable errors seems not in a trend in Rust, it is unknown what the long-term consequences of this. I'm not totally against this PR, but I would like to hear what the situations where you need to clone errors?

Thanks for the quick response and that's very fair. My own use case: I've a task that owns a socket and reads and parses messages from the socket and then forwards them to all interested parties (streams) through a broadcast channel. Since Result only implements Clone when E: Clone, I can not send a Result the channel. Currently I work around this by using a broadcast channel only for success and a separate channel for error but that means that I only communicate the error to one of the streams.

Please note that in my crate, I'm fixing the std::io::Error issue a bit differently, which won't work for you unless you're ok with breaking API (my error type is non_exhaustive) so I went with the approach in the PR.

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.

I'm fine with replacing Error::Io(IoError) to Error::Io(Arc<IoError>), which, I think, would be more elegant solution. We also can hide that under a feature flag (say, cloneable-errors), but I think that this is not required (besides, that is anti-pattern, because that create a incompatible API depending on the feature flags, which should be avoided). @dralley, what to you think?

Whatever path we choose, it is important to describe it in the documentation for Error, and add a changelog entry.

I think, that will resolve #360?

@zeenix
Copy link
Contributor Author

zeenix commented Dec 7, 2022

I'm fine with replacing Error::Io(IoError) to Error::Io(Arc<IoError>), which, I think, would be more elegant solution.

I completely agree. I will revise the commits after hearing opinion of @dralley.

Whatever path we choose, it is important to describe it in the documentation for Error,
and add a changelog entry.

For sure. I'll do that as part of the update.

@zeenix
Copy link
Contributor Author

zeenix commented Dec 7, 2022

I think, that will resolve #360?

Not sure. single consumer APIs should not require cloning.

@dralley
Copy link
Collaborator

dralley commented Dec 7, 2022

I'm fine with Arc<IoError>. Agreed about not wanting divergent signatures.

@zeenix
Copy link
Contributor Author

zeenix commented Dec 7, 2022

@Mingun Updated the commits. PTALA.

@zeenix zeenix requested a review from Mingun December 7, 2022 23:30
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.

impl<E: Error> Error for Arc<E> was implemented in Rust 1.52, so need to bump our MSRV. Please add a note about that to the Changelog, before "New Features" section

Changelog.md Outdated Show resolved Hide resolved
Changelog.md Outdated Show resolved Hide resolved
We'll be making use `impl<E: Error> Error for Arc<E>` that was introduced
in 1.52.
The `?` handles the tranformation for us.
This would allow using crates to embed errors from this crate into their
error types that implement Clone.

Unfortunately `std::io::Error` does not implement `Clone` [1] so we've
to wrap it in an `Arc`.
@zeenix zeenix requested review from dralley and Mingun and removed request for Mingun and dralley December 8, 2022 16:12
@zeenix
Copy link
Contributor Author

zeenix commented Dec 8, 2022

Lol, apparently GH wants me to only request review from one person. :) Sorry about adding and removing dance.

@Mingun Mingun merged commit a888cb6 into tafia:master Dec 8, 2022
@Mingun
Copy link
Collaborator

Mingun commented Dec 8, 2022

Thanks!

@zeenix zeenix deleted the clone-on-error branch December 8, 2022 21:24
crapStone added a commit to Calciumdibromid/CaBr2 that referenced this pull request Dec 29, 2022
This PR contains the following updates:

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

---

### Release Notes

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

### [`v0.27.1`](https://github.com/tafia/quick-xml/blob/HEAD/Changelog.md#&#8203;0271----2022-12-28)

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

##### Bug Fixes

-   [#&#8203;530]: Fix an infinite loop leading to unbounded memory consumption that occurs when
    skipping events on malformed XML with the `overlapped-lists` feature active.
-   [#&#8203;530]: Fix an error in the `Deserializer::read_to_end` when `overlapped-lists`
    feature is active and malformed XML is parsed

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

### [`v0.27.0`](https://github.com/tafia/quick-xml/blob/HEAD/Changelog.md#&#8203;0270----2022-12-25)

[Compare Source](tafia/quick-xml@v0.26.0...v0.27.0)

##### New Features

-   [#&#8203;521]: Implement `Clone` for all error types. This required changing `Error::Io` to contain
    `Arc<std::io::Error>` instead of `std::io::Error` since `std::io::Error` does not implement
    `Clone`.

##### Bug Fixes

-   [#&#8203;490]: Ensure that serialization of map keys always produces valid XML names.
    In particular, that means that maps with numeric and numeric-like keys (for
    example, `"42"`) no longer can be serialized because [XML name] cannot start
    from a digit
-   [#&#8203;500]: Fix deserialization of top-level sequences of enums, like
    ```xml
    <?xml version="1.0" encoding="UTF-8"?>
    <!-- list of enum Enum { A, B, С } -->
    <A/>
    <B/>
    <C/>
    ```
-   [#&#8203;514]: Fix wrong reporting `Error::EndEventMismatch` after disabling and enabling
    `.check_end_names`
-   [#&#8203;517]: Fix swapped codes for `\r` and `\n` characters when escaping them
-   [#&#8203;523]: Fix incorrect skipping text and CDATA content before any map-like structures
    in serde deserializer, like
    ```xml
    unwanted text<struct>...</struct>
    ```
-   [#&#8203;523]: Fix incorrect handling of `xs:list`s with encoded spaces: they still
    act as delimiters, which is confirmed also by mature XmlBeans Java library
-   [#&#8203;473]: Fix a hidden requirement to enable serde's `derive` feature to get
    quick-xml's `serialize` feature for `edition = 2021` or `resolver = 2` crates

##### Misc Changes

-   [#&#8203;490]: Removed `$unflatten=` special prefix for fields for serde (de)serializer, because:

    -   it is useless for deserializer
    -   serializer was rewritten and does not require it anymore

    This prefix allowed you to serialize struct field as an XML element and now
    replaced by a more thoughtful system explicitly indicating that a field should
    be serialized as an attribute by prepending `@` character to its name
-   [#&#8203;490]: Removed `$primitive=` prefix. That prefix allowed you to serialize struct
    field as an attribute instead of an element and now replaced by a more thoughtful
    system explicitly indicating that a field should be serialized as an attribute
    by prepending `@` character to its name
-   [#&#8203;490]: In addition to the `$value` special name for a field a new `$text`
    special name was added:

    -   `$text` is used if you want to map field to text content only. No markup is
        expected (but text can represent a list as defined by `xs:list` type)
    -   `$value` is used if you want to map elements with different names to one field,
        that should be represented either by an `enum`, or by sequence of `enum`s
        (`Vec`, tuple, etc.), or by string. Use it when you want to map field to any
        content of the field, text or markup

    Refer to [documentation] for details.
-   [#&#8203;521]: MSRV bumped to 1.52.
-   [#&#8203;473]: `serde` feature that used to make some types serializable, renamed to `serde-types`
-   [#&#8203;528]: Added documentation for XML to `serde` mapping

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

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

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

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

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

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

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

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

[XML name]: https://www.w3.org/TR/xml11/#NT-Name

[documentation]: https://docs.rs/quick-xml/0.27.0/quick_xml/de/index.html#difference-between-text-and-value-special-names

</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:eyJjcmVhdGVkSW5WZXIiOiIzNC43My4wIiwidXBkYXRlZEluVmVyIjoiMzQuNzQuMiJ9-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Co-authored-by: crapStone <crapstone01@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1692
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.

3 participants