Refactor the crate to be more ergonomic (Breaking changes) #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Replace awkward `Vcard {[[VElement]]}` with a struct and custom `impl Serialize` for it
(Deserialize is not fully supported yet, only some types have the `derive`)
- Convert `mod tests` into doctests to make that code more useful.
- Add documentation
- Replace `Vcard::add_*`, `Property::new_*` constructors are used. `Vcard` only has a `push` method now.
- Use more `impl Into<T>` as parameters to constructors to allow the user to suppy more types
which are efficiently converted into the appropriate types.
- Remove the `{cc: AT}` parameter from the address property. This parameter is not required by
RFC 6350 (vCard) nor RFC 7095 (jCard), so it was removed. If you rely on this parameter, please add it at
the call site.
BREAKING CHANGE: Major changes to the crate's API.
- Translate the readme to English - Add more docs to `cargo doc` pages - Fail serialization if the values array is empty.
|
Good so far, LGTM! @m-kuzmin thank you for your contributions. I'll try to update working production with the latest version for deployment references. |
orzklv
approved these changes
Apr 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog
Vcard {elelements: [[VElement]]}with a more type safeVCard { properties, ... }and implementSerialize&Deserializefor it.Vcard::add_*withProperty::new_*constructors.Vcardonly has apushmethod now.impl Into<T>as parameters to constructors to allow the user to suppy different types,which are efficiently converted into the appropriate types. For example:
{cc: AT}parameter from the address property. This parameter is not required byRFC 6350 (vCard) nor RFC 7095 (jCard), so it was removed. If you rely on this parameter, please add it at
the call site.