Struct KeyPrefix 

pub struct KeyPrefix { /* private fields */ }

A 2-byte key prefix containing version and record tag.

This type encapsulates the standard prefix used by all OpenData records. It provides methods for serialization, deserialization, and validation.

Examples

use common::serde::key_prefix::{KeyPrefix, RecordTag};

// Create a prefix
let prefix = KeyPrefix::new(0x01, RecordTag::new(0x02, 0x00));
assert_eq!(prefix.version(), 0x01);
assert_eq!(prefix.tag().record_type(), 0x02);

// Serialize and deserialize
let bytes = prefix.to_bytes();
let parsed = KeyPrefix::from_bytes(&bytes).unwrap();
assert_eq!(parsed, prefix);

Implementations

impl KeyPrefix

pub fn new(version: u8, tag: RecordTag) -> Self

Creates a new key prefix with the given version and record tag.

pub fn version(&self) -> u8

Returns the version byte.

pub fn tag(&self) -> RecordTag

Returns the record tag.

pub fn from_bytes(data: &[u8]) -> Result<Self, DeserializeError>

Parses a key prefix from a byte slice.

Errors

Returns an error if:

• The buffer is too short (less than 2 bytes)
• The record type is 0 (reserved)

pub fn from_bytes_versioned( data: &[u8], expected_version: u8, ) -> Result<Self, DeserializeError>

Parses a key prefix, validating the version matches expected.

Errors

Returns an error if:

• The buffer is too short
• The version doesn’t match
• The record type is 0

pub fn to_bytes(&self) -> Bytes

Serializes the prefix to a 2-byte array.

pub fn write_to(&self, buf: &mut BytesMut)

Writes the prefix to a buffer.

Trait Implementations

impl Clone for KeyPrefix

fn clone(&self) -> KeyPrefix

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyPrefix

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KeyPrefix

fn eq(&self, other: &KeyPrefix) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for KeyPrefix

impl Eq for KeyPrefix

impl StructuralPartialEq for KeyPrefix