Enum VectorId 

pub enum VectorId {
    U64(u64),
    Bytes(Box<[u8]>),
}

A stable identifier for a stored vector.

Either a compact U64 integer id or an opaque Bytes key. Build a U64 id with From<u64>; build a Bytes id with TryFrom<Vec<u8>>, which rejects an empty key.

Examples

use iqdb_types::VectorId;

let numeric = VectorId::from(7u64);
assert_eq!(numeric, VectorId::U64(7));

let key = VectorId::try_from(vec![0xde, 0xad]).expect("non-empty key");
assert_eq!(key, VectorId::Bytes(vec![0xde, 0xad].into_boxed_slice()));

// An empty byte key is rejected.
assert!(VectorId::try_from(Vec::new()).is_err());

Variants

U64(u64)

A compact 64-bit integer id (for example, a row id).

Bytes(Box<[u8]>)

An opaque, non-empty byte key (for example, a content hash or a UUID’s raw bytes).

Trait Implementations

impl Clone for VectorId

fn clone(&self) -> VectorId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorId

fn deserialize<__D>( __deserializer: __D, ) -> Result<VectorId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VectorId

Operator-facing rendering: U64 is the decimal integer; Bytes is lowercase hex with no prefix and no separators (so a 32-byte SHA-256-shaped id renders as 64 hex characters). Debug keeps the Bytes([...]) shape for in-source troubleshooting; Display is the shape that lands in operator-facing logs and error messages.

Examples

use iqdb_types::VectorId;

assert_eq!(VectorId::from(7u64).to_string(), "7");

let key = VectorId::try_from(vec![0xde, 0xad, 0xbe, 0xef]).expect("non-empty");
assert_eq!(key.to_string(), "deadbeef");

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

Formats the value using the given formatter.

impl Eq for VectorId

impl From<u64> for VectorId

fn from(value: u64) -> VectorId

Converts to this type from the input type.

impl Hash for VectorId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VectorId

fn eq(&self, other: &VectorId) -> 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 Serialize for VectorId

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VectorId

impl TryFrom<Vec<u8>> for VectorId

fn try_from( bytes: Vec<u8>, ) -> Result<VectorId, <VectorId as TryFrom<Vec<u8>>>::Error>

Builds a Bytes id, rejecting an empty key with IqdbError::InvalidConfig (a malformed identifier is a configuration shape problem, not a malformed vector).

type Error = IqdbError

The type returned in the event of a conversion error.