Struct PrefixedUuid 

pub struct PrefixedUuid<const PFX_1: char, const PFX_2: char, const PFX_3: char> { /* private fields */ }

A UUID with a 3-character prefix for type-safe identifiers.

This struct wraps a standard UUID and adds a compile-time prefix, ensuring that different types of identifiers (API keys, swarm IDs, etc.) cannot be confused at the type level.

The prefix is specified as three const char generic parameters.

Type Parameters

• PFX_1 - First character of the prefix
• PFX_2 - Second character of the prefix
• PFX_3 - Third character of the prefix

Examples

use objectiveai_sdk::prefixed_uuid::PrefixedUuid;

// Define an API key type with prefix "apk"
type ApiKey = PrefixedUuid<'a', 'p', 'k'>;

// Create a new API key
let key = ApiKey::new();
println!("{}", key); // Outputs: apk<uuid>

Implementations

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> PrefixedUuid<PFX_1, PFX_2, PFX_3>

pub fn new() -> Self

Creates a new prefixed UUID with a random v4 UUID.

Examples

use objectiveai_sdk::prefixed_uuid::PrefixedUuid;

type ApiKey = PrefixedUuid<'a', 'p', 'k'>;
let key = ApiKey::new();

pub fn uuid(&self) -> Uuid

Returns the underlying UUID without the prefix.

Examples

use objectiveai_sdk::prefixed_uuid::PrefixedUuid;

type ApiKey = PrefixedUuid<'a', 'p', 'k'>;
let key = ApiKey::new();
let uuid = key.uuid();

Trait Implementations

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Clone for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn clone(&self) -> PrefixedUuid<PFX_1, PFX_2, PFX_3>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Debug for PrefixedUuid<PFX_1, PFX_2, PFX_3>

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

Formats the value using the given formatter.

impl<'de, const PFX_1: char, const PFX_2: char, const PFX_3: char> Deserialize<'de> for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Display for PrefixedUuid<PFX_1, PFX_2, PFX_3>

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

Formats the value using the given formatter.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> From<Uuid> for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn from(uuid: Uuid) -> Self

Converts to this type from the input type.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> FromStr for PrefixedUuid<PFX_1, PFX_2, PFX_3>

type Err = ParseError<PFX_1, PFX_2, PFX_3>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Hash for PrefixedUuid<PFX_1, PFX_2, PFX_3>

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

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<const PFX_1: char, const PFX_2: char, const PFX_3: char> JsonSchema for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Ord for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn cmp(&self, other: &PrefixedUuid<PFX_1, PFX_2, PFX_3>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> PartialEq for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn eq(&self, other: &PrefixedUuid<PFX_1, PFX_2, PFX_3>) -> 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<const PFX_1: char, const PFX_2: char, const PFX_3: char> PartialOrd for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn partial_cmp( &self, other: &PrefixedUuid<PFX_1, PFX_2, PFX_3>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Serialize for PrefixedUuid<PFX_1, PFX_2, PFX_3>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Copy for PrefixedUuid<PFX_1, PFX_2, PFX_3>

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> Eq for PrefixedUuid<PFX_1, PFX_2, PFX_3>

impl<const PFX_1: char, const PFX_2: char, const PFX_3: char> StructuralPartialEq for PrefixedUuid<PFX_1, PFX_2, PFX_3>