Package 'uuidx'

Title: Modern UUIDs for R with a Rust Backend
Description: Generate, parse, and validate RFC 9562 UUIDs from R using the Rust 'uuid' crate via 'extendr'. Developed by Thomas Bryce Kelly at Icy Seas Co-Laboratory LLC. Version 7 UUIDs are the default for new identifiers, while versions 4, 5, 6, and legacy version 1 are also supported. Functions return character vectors by default and can also expose 16-byte raw representations for low-level workflows.
Authors: Thomas Bryce Kelly [aut, cre], Icy Seas Co-Laboratory LLC [cph]
Maintainer: Thomas Bryce Kelly <[email protected]>
License: MIT + file LICENSE
Version: 0.0.1
Built: 2026-05-10 09:13:09 UTC
Source: https://github.com/cran/uuidx

Help Index

Generate UUIDs

Description

uuid_generate() is the main entry point for new UUID creation. It defaults to version 7, which is typically a practical default for new identifiers because it keeps the randomness users expect while sorting naturally by time.

Usage

uuid_generate(
  n = 1L,
  version = c("v7", "v4", "v5", "v6", "v1"),
  namespace = NULL,
  name = NULL,
  output = c("string", "raw")
)

Arguments

n

Number of UUIDs to generate. Must be a single non-negative integer.
version

UUID version to generate. Defaults to "v7".
namespace

Namespace UUID used for version 5 generation. Standard aliases "dns", "url", "oid", and "x500" are accepted.
name

Name value or values used for version 5 generation.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Details

Version 5 is name-based and deterministic, so it uses namespace and name instead of n.

Value

A character vector for output = "string" or a list of raw vectors for output = "raw".

Examples

uuid_generate()
uuid_generate(3, version = "v4")
uuid_generate(version = "v5", namespace = "dns", name = c("a", "b"))

Return the Max UUID

Description

Return the Max UUID

Usage

uuid_max(output = c("string", "raw"))

Arguments

output

Output format. "string" returns the canonical UUID string and "raw" returns a raw vector of length 16.

Value

A length-one character vector or a raw vector.

Examples

uuid_max()
uuid_max(output = "raw")

Return the Nil UUID

Description

Return the Nil UUID

Usage

uuid_nil(output = c("string", "raw"))

Arguments

output

Output format. "string" returns the canonical UUID string and "raw" returns a raw vector of length 16.

Value

A length-one character vector or a raw vector.

Examples

uuid_nil()
uuid_nil(output = "raw")

Parse UUIDs

Description

uuid_parse() canonicalizes UUID strings and can optionally expose their raw bytes or field-level structure.

Usage

uuid_parse(x, output = c("string", "raw", "fields"))

Arguments

x

Character vector of UUID strings.
output

Output format. "string" returns canonical strings, "raw" returns a list of 16-byte raw vectors, and "fields" returns a data frame with class "uuid_fields".

Details

For output = "fields", the returned data frame exposes structural UUID fields. These field names follow the conventional UUID layout, although the semantics of those fields vary by UUID version.

Value

A character vector, a list of raw vectors, or a "uuid_fields" data frame depending on output.

Examples

x = uuid_v7(2)
uuid_parse(x)
uuid_parse(x, output = "raw")
uuid_parse(x, output = "fields")

Generate Legacy Version 1 UUIDs

Description

Version 1 remains available for compatibility work, but it is treated as a legacy option in this package.

Usage

uuid_v1(n = 1L, output = c("string", "raw"))

Arguments

n

Number of UUIDs to generate. Must be a single non-negative integer.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Value

A character vector or a list of 16-byte raw vectors.

Generate Version 4 UUIDs

Description

Version 4 UUIDs are fully random identifiers.

Usage

uuid_v4(n = 1L, output = c("string", "raw"))

Arguments

n

Number of UUIDs to generate. Must be a single non-negative integer.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Value

A character vector or a list of 16-byte raw vectors.

Generate Deterministic Version 5 UUIDs

Description

Version 5 UUIDs are derived from a namespace UUID and a name using SHA-1.

Usage

uuid_v5(namespace, name, output = c("string", "raw"))

Arguments

namespace

Namespace UUID or one of "dns", "url", "oid", or "x500".
name

One or more name strings.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Value

A character vector or a list of 16-byte raw vectors.

Examples

uuid_v5("dns", "example.com")
uuid_v5("dns", c("alpha", "beta"))

Generate Version 6 UUIDs

Description

Version 6 UUIDs retain the timestamp-based lineage of version 1 while being more naturally sortable.

Usage

uuid_v6(n = 1L, output = c("string", "raw"))

Arguments

n

Number of UUIDs to generate. Must be a single non-negative integer.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Value

A character vector or a list of 16-byte raw vectors.

Generate Version 7 UUIDs

Description

Version 7 UUIDs are time-ordered and are the default in uuidx.

Usage

uuid_v7(n = 1L, output = c("string", "raw"))

Arguments

n

Number of UUIDs to generate. Must be a single non-negative integer.
output

Output format. "string" returns canonical UUID strings and "raw" returns a list of raw vectors, each of length 16.

Value

A character vector or a list of 16-byte raw vectors.

Validate UUID Strings

Description

Validate UUID Strings

Usage

uuid_validate(x)

Arguments

x

Vector to validate.

Value

A logical vector where valid UUIDs are TRUE.

Examples

uuid_validate(c(uuid_v7(), "not-a-uuid"))

Detect UUID Versions

Description

Detect UUID Versions

Usage

uuid_version(x)

Arguments

x

Vector of UUID strings.

Value

An integer vector containing UUID version numbers, with NA for invalid inputs.

Examples

x = c(uuid_v7(), uuid_v4(), "not-a-uuid")
uuid_version(x)