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

Remove uses of SerializeValuesError and deprecate it #1149

Merged

Conversation

wprzytula
Copy link
Collaborator

@wprzytula wprzytula commented Dec 11, 2024

SerializeValuesError is part of the legacy serialization API, so it should be deprecated as well.

Refs: #1139

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • [ ] I have adjusted the documentation in ./docs/source/.
  • [ ] I added appropriate Fixes: annotations to PR description.

Only one variant of the legacy SerializeValuesError was used:
TooManyValues. In order to remove it entirely, a corresponding variant
is introduced to the BuiltinSerializationErrorKind.
@wprzytula wprzytula added the API-stability Part of the effort to stabilize the API label Dec 11, 2024
@wprzytula wprzytula added this to the 0.15.1 milestone Dec 11, 2024
@wprzytula wprzytula self-assigned this Dec 11, 2024
scylla-cql/src/frame/value.rs Outdated Show resolved Hide resolved
@github-actions github-actions bot added the semver-checks-breaking cargo-semver-checks reports that this PR introduces breaking API changes label Dec 11, 2024
Copy link

github-actions bot commented Dec 11, 2024

cargo semver-checks detected some API incompatibilities in this PR.
Checked commit: 59eb5c1

See the following report for details:

cargo semver-checks output
./scripts/semver-checks.sh --baseline-rev 868d86ffa3b97930a79de5ac2bcc3644d93a326a
+ cargo semver-checks -p scylla -p scylla-cql --baseline-rev 868d86ffa3b97930a79de5ac2bcc3644d93a326a
     Cloning 868d86ffa3b97930a79de5ac2bcc3644d93a326a
    Building scylla v0.15.0 (current)
       Built [  25.721s] (current)
     Parsing scylla v0.15.0 (current)
      Parsed [   0.056s] (current)
    Building scylla v0.15.0 (baseline)
       Built [  23.110s] (baseline)
     Parsing scylla v0.15.0 (baseline)
      Parsed [   0.053s] (baseline)
    Checking scylla v0.15.0 -> v0.15.0 (no change)
     Checked [   0.111s] 95 checks: 95 pass, 0 skip
     Summary no semver update required
    Finished [  49.968s] scylla
    Building scylla-cql v0.4.0 (current)
       Built [  11.343s] (current)
     Parsing scylla-cql v0.4.0 (current)
      Parsed [   0.036s] (current)
    Building scylla-cql v0.4.0 (baseline)
       Built [  11.357s] (baseline)
     Parsing scylla-cql v0.4.0 (baseline)
      Parsed [   0.035s] (baseline)
    Checking scylla-cql v0.4.0 -> v0.4.0 (no change)
     Checked [   0.104s] 95 checks: 94 pass, 1 fail, 0 warn, 0 skip

--- failure type_marked_deprecated: #[deprecated] added on type ---

Description:
A type is now #[deprecated]. Downstream crates will get a compiler warning when using this type.
        ref: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.37.0/src/lints/type_marked_deprecated.ron

Failed in:
  Enum SerializeValuesError in /home/runner/work/scylla-rust-driver/scylla-rust-driver/scylla-cql/src/frame/value.rs:671

     Summary semver requires new minor version: 0 major and 1 minor checks failed
    Finished [  23.417s] scylla-cql
make: *** [Makefile:61: semver-rev] Error 1

This is part of the legacy serialization framework.
@wprzytula wprzytula force-pushed the remove-uses-of-serialize-values-error branch from 77d1846 to 59eb5c1 Compare December 11, 2024 14:04
@wprzytula wprzytula requested a review from Lorak-mmk December 11, 2024 14:06
@wprzytula wprzytula merged commit 3d4dd69 into scylladb:main Dec 11, 2024
11 checks passed
@wprzytula wprzytula deleted the remove-uses-of-serialize-values-error branch December 11, 2024 14:19
wprzytula added a commit to wprzytula/scylla-rust-driver that referenced this pull request Dec 11, 2024
…ize-values-error

Remove uses of `SerializeValuesError` and deprecate it

(cherry picked from commit 3d4dd69)
@wprzytula wprzytula mentioned this pull request Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API-stability Part of the effort to stabilize the API semver-checks-breaking cargo-semver-checks reports that this PR introduces breaking API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants