This repository was archived by the owner on Jul 30, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 155
arcify data #788
Closed
Closed
arcify data #788
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
40 changes: 40 additions & 0 deletions
40
apps/nextra/pages/en/build/indexer/indexer-sdk/documentation/arcify-data.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| title: "Arcifying Step" | ||
| --- | ||
|
|
||
| # Overview | ||
|
|
||
| The `ArcifyStep` is a utility step in the processing pipeline that transforms owned data into reference-counted `Arc` instances. This is particularly useful when the data needs to be shared across multiple components or threads without unnecessary cloning. | ||
|
|
||
| ## Key Responsibilities | ||
|
|
||
| 1. **Convert to `Arc`**: Converts a vector of owned items into a vector of `Arc`-wrapped items. | ||
| 2. **Preserve Metadata**: Maintains the transaction context metadata during transformation. | ||
|
|
||
| ## How It Works | ||
|
|
||
| - The `ArcifyStep` takes a `TransactionContext` containing a vector of owned items. | ||
| - Each item in the vector is wrapped in an `Arc` to enable efficient sharing. | ||
| - The metadata from the original context is preserved in the output. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ### Converting Data to `Arc` | ||
|
|
||
| ```rust | ||
| let mut arcify_step = ArcifyStep::new(); | ||
| let input_context = TransactionContext { | ||
| data: vec![1, 2, 3], | ||
| metadata: TransactionMetadata { | ||
| start_version: 0, | ||
| end_version: 0, | ||
| start_transaction_timestamp: None, | ||
| end_transaction_timestamp: None, | ||
| total_size_in_bytes: 0, | ||
| }, | ||
| }; | ||
|
|
||
| let result = arcify_step.process(input_context).await.unwrap().unwrap(); | ||
| assert_eq!(*result.data[0], 1); | ||
| ``` | ||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
might not need a separate page for this