[guard] Update BStackGuardedSlice with BStackSlice parities, new pre/post processing, and crash-atomic APIs - #73
Merged
Merged
Conversation
…ew pre/post processing methods while deprecating old, and add atomic APIs
…ariant in CHANGELOG
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
1 participant
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: Maintain previously undermaintained
BStackGuardedSlice. It now gains a full I/O surface derived from whole-blockdecode/encode. The transform hooks are now whole-block:decodemaps the raw stored bytes to the apparent (decoded) bytes andencodethe reverse — both default to identity, so a transforming guard (encryption, compression) implements onlylen,raw_block,decode, andencode. It provides various io methods that are parity to what BStackSlice already provides, such asread,read_range,get,contains,find/rfind,write/copy_from_slice,zero/fill,process,copy_within, etc. All methods are crash-atomic, either through a singleBStackcall, tylically routed through underlyingBStackSlice, or throughBStack::process_genthat decodes, mutates, re-encodes, and writes under a single held lock, aborting when encountering errors.Important Feature: No
Type: Feature
Tests: Included
Feature Flags: guard
Breaking change: No (but with deprecation to some methods)
New Types: None
Rust Only: Yes
Fuzz: No
Safety Review: Needed: Invariants, Correctness