Merge commit 'd803bfe2b1fe7f5e219e50ac20d6801a0a58ac75' as 'vendor/ruvector'
This commit is contained in:
30
vendor/ruvector/crates/rvf/rvf-wire/README.md
vendored
Normal file
30
vendor/ruvector/crates/rvf/rvf-wire/README.md
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
# rvf-wire
|
||||
|
||||
Zero-copy wire format reader and writer for RuVector Format (RVF) segments.
|
||||
|
||||
## Overview
|
||||
|
||||
`rvf-wire` handles serialization and deserialization of RVF binary segments:
|
||||
|
||||
- **Writer** -- append segments with automatic CRC32c and XXH3 checksums
|
||||
- **Reader** -- stream-parse segments with validation and integrity checks
|
||||
- **Zero-copy** -- borrows directly from memory-mapped buffers where possible
|
||||
|
||||
## Usage
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
rvf-wire = "0.1"
|
||||
```
|
||||
|
||||
```rust
|
||||
use rvf_wire::{SegmentWriter, SegmentReader};
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
- `std` (default) -- enable `std` I/O support
|
||||
|
||||
## License
|
||||
|
||||
MIT OR Apache-2.0
|
||||
Reference in New Issue
Block a user