Skip to content

Remove unused PrimaryKey::parse_key #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 12, 2021
Merged

Remove unused PrimaryKey::parse_key #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions packages/storage-plus/src/helpers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,6 @@ pub(crate) fn encode_length(namespace: &[u8]) -> [u8; 2] {
[length_bytes[2], length_bytes[3]]
}

// pub(crate) fn decode_length(prefix: [u8; 2]) -> usize {
pub(crate) fn decode_length(prefix: &[u8]) -> usize {
// TODO: enforce exactly 2 bytes somehow, but usable with slices
(prefix[0] as usize) * 256 + (prefix[1] as usize)
}

#[cfg(test)]
mod test {
use super::*;
Expand Down
111 changes: 2 additions & 109 deletions packages/storage-plus/src/keys.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
use std::marker::PhantomData;
use std::str::from_utf8;

use crate::helpers::{decode_length, namespaces_with_key};
use crate::helpers::namespaces_with_key;
use crate::Endian;

// pub trait PrimaryKey<'a>: Copy {
Expand All @@ -17,10 +16,6 @@ pub trait PrimaryKey<'a>: Clone {
let l = keys.len();
namespaces_with_key(&keys[0..l - 1], &keys[l - 1])
}

/// extracts a single or composite key from a joined key,
/// only lives as long as the original bytes
fn parse_key(serialized: &'a [u8]) -> Self;
}

impl<'a> PrimaryKey<'a> for &'a [u8] {
Expand All @@ -31,10 +26,6 @@ impl<'a> PrimaryKey<'a> for &'a [u8] {
// this is simple, we don't add more prefixes
vec![self]
}

fn parse_key(serialized: &'a [u8]) -> Self {
serialized
}
}

// Provide a string version of this to raw encode strings
Expand All @@ -46,10 +37,6 @@ impl<'a> PrimaryKey<'a> for &'a str {
// this is simple, we don't add more prefixes
vec![self.as_bytes()]
}

fn parse_key(serialized: &'a [u8]) -> Self {
from_utf8(serialized).unwrap()
}
}

// use generics for combining there - so we can use &[u8], PkOwned, or IntKey
Expand All @@ -62,13 +49,6 @@ impl<'a, T: PrimaryKey<'a> + Prefixer<'a>, U: PrimaryKey<'a>> PrimaryKey<'a> for
keys.extend(&self.1.key());
keys
}

fn parse_key(serialized: &'a [u8]) -> Self {
let l = decode_length(&serialized[0..2]);
let first = &serialized[2..l + 2];
let second = &serialized[l + 2..];
(T::parse_key(first), U::parse_key(second))
}
}

// use generics for combining there - so we can use &[u8], PkOwned, or IntKey
Expand All @@ -84,19 +64,6 @@ impl<'a, T: PrimaryKey<'a> + Prefixer<'a>, U: PrimaryKey<'a> + Prefixer<'a>, V:
keys.extend(&self.2.key());
keys
}

fn parse_key(serialized: &'a [u8]) -> Self {
let l1 = decode_length(&serialized[0..2]);
let first = &serialized[2..2 + l1];
let l2 = decode_length(&serialized[2 + l1..2 + l1 + 2]);
let second = &serialized[2 + l1 + 2..2 + l1 + 2 + l2];
let third = &serialized[2 + l1 + 2 + l2..];
(
T::parse_key(first),
U::parse_key(second),
V::parse_key(third),
)
}
}

// pub trait Prefixer<'a>: Copy {
Expand Down Expand Up @@ -161,10 +128,6 @@ impl<'a> PrimaryKey<'a> for PkOwned {
fn key(&self) -> Vec<&[u8]> {
vec![&self.0]
}

fn parse_key(serialized: &'a [u8]) -> Self {
PkOwned(serialized.to_vec())
}
}

impl<'a> Prefixer<'a> for PkOwned {
Expand All @@ -181,10 +144,6 @@ impl<'a, T: AsRef<PkOwned> + From<PkOwned> + Clone> PrimaryKey<'a> for T {
fn key(&self) -> Vec<&[u8]> {
self.as_ref().key()
}

fn parse_key(serialized: &'a [u8]) -> Self {
PkOwned::parse_key(serialized).into()
}
}

// this auto-implements Prefixer for all the IntKey types (and more!)
Expand Down Expand Up @@ -291,8 +250,7 @@ mod test {
assert_eq!("hello".as_bytes(), path[0]);

let joined = k.joined_key();
let parsed = K::parse_key(&joined);
assert_eq!(parsed, "hello");
assert_eq!(joined, b"hello")
}

#[test]
Expand Down Expand Up @@ -343,71 +301,6 @@ mod test {
assert_eq!(dir, vec![foo, b"bar"]);
}

#[test]
fn parse_joined_keys_pk1() {
type K<'a> = &'a [u8];

let key: K = b"four";
let joined = key.joined_key();
assert_eq!(key, joined.as_slice());
let parsed = K::parse_key(&joined);
assert_eq!(key, parsed);
}

#[test]
fn parse_joined_keys_pk2() {
type K<'a> = (&'a [u8], &'a [u8]);

let key: K = (b"four", b"square");
let joined = key.joined_key();
assert_eq!(4 + 6 + 2, joined.len());
let parsed = K::parse_key(&joined);
assert_eq!(key, parsed);
}

#[test]
fn parse_joined_keys_pk3() {
type K<'a> = (&'a str, U32Key, &'a [u8]);

let key: K = ("four", 15.into(), b"cinco");
let joined = key.joined_key();
assert_eq!(4 + 4 + 5 + 2 * 2, joined.len());
let parsed = K::parse_key(&joined);
assert_eq!(key, parsed);
}

#[test]
fn parse_joined_keys_pk3_alt() {
type K<'a> = (&'a str, U64Key, &'a str);

let key: K = ("one", 222.into(), "three");
let joined = key.joined_key();
assert_eq!(3 + 8 + 5 + 2 * 2, joined.len());
let parsed = K::parse_key(&joined);
assert_eq!(key, parsed);
}

#[test]
fn parse_joined_keys_int() {
let key: U64Key = 12345678.into();
let joined = key.joined_key();
assert_eq!(8, joined.len());
let parsed = U64Key::parse_key(&joined);
assert_eq!(key, parsed);
}

#[test]
fn parse_joined_keys_string_int() {
type K<'a> = (U32Key, &'a str);

let key: K = (54321.into(), "random");
let joined = key.joined_key();
assert_eq!(2 + 4 + 6, joined.len());
let parsed = K::parse_key(&joined);
assert_eq!(key, parsed);
assert_eq!("random", parsed.1);
}

#[test]
fn proper_prefixes() {
let simple: &str = "hello";
Expand Down