align UUID reducer examples with allowed signatures#3999
Open
GEFNENEN wants to merge 2 commits intoclockworklabs:masterfrom
Open
align UUID reducer examples with allowed signatures#3999GEFNENEN wants to merge 2 commits intoclockworklabs:masterfrom
GEFNENEN wants to merge 2 commits intoclockworklabs:masterfrom
Conversation
Signed-off-by: miXin <52082254@qq.com>
align UUID reducer examples with allowed signatures
There was a problem hiding this comment.
Pull request overview
This pull request updates the UUID reducer documentation examples to align with the valid reducer signatures (() or Result<(), E>). The changes ensure the example function signatures match the allowed return types for reducers.
Changes:
- Updated UUID v4 reducer example to return
()instead ofUuid - Updated UUID v7 reducer example to return
Result<(), Box<dyn std::error::Error>>instead ofResult<Uuid, ...> - Added
Ok(())return statement to complete the UUID v7 example
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| /// #[reducer] | ||
| /// fn generate_uuid_v4(ctx: &ReducerContext) -> Uuid { | ||
| /// fn generate_uuid_v4(ctx: &ReducerContext) { | ||
| /// let uuid = ctx.new_uuid_v4(); |
There was a problem hiding this comment.
The function new_uuid_v4() returns anyhow::Result<Uuid>, but the Result is not being handled here. Since the reducer signature returns (), you need to either:
- Handle the error explicitly (e.g., using
.unwrap(),.expect(), or a match statement), or - Change the reducer signature to return
Result<(), impl std::fmt::Display>and use the?operator to propagate the error, similar to thegenerate_uuid_v7example below.
Suggested change
| /// let uuid = ctx.new_uuid_v4(); | |
| /// let uuid = ctx.new_uuid_v4().expect("failed to generate UUID v4"); |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of Changes
API and ABI breaking changes
Expected complexity level and risk
Testing