Struct KafkaUuid 

pub struct KafkaUuid(pub Uuid);

A Kafka Uuid: a cluster id, topic id, or log-directory id.

This is the value type of org.apache.kafka.common.Uuid. Kafka prints these ids as 22 characters of unpadded base64url, for example UXyU9i5ARn6W00ON2taeWA, not as the hyphenated hex form that uuid::Uuid prints. Display and FromStr use the Kafka form. So does serde, which always writes the id as that string.

FromStr matches Uuid.fromString in Apache Kafka 4.3.1. It accepts exactly the inputs that Kafka accepts and gives the same error messages. Two consequences are not obvious:

• Kafka ignores the unused low bits of the last character, so _____________________x parses to the same id as _____________________w.
• Kafka also accepts the 22 characters followed by ==.

Parsing never rejects a reserved id. Kafka’s fromString does not reject them, and kafka-storage format --cluster-id stores any string. Check is_reserved where a caller must refuse one.

The ordering is Kafka’s compareTo: it compares the two halves as signed 64-bit integers, most significant half first. This is not the unsigned byte order of uuid::Uuid.

Examples

use krabka_ids::KafkaUuid;

let id: KafkaUuid = "UXyU9i5ARn6W00ON2taeWA".parse()?;
assert2::assert!(id.to_string() == "UXyU9i5ARn6W00ON2taeWA");
assert2::assert!(KafkaUuid::METADATA_TOPIC_ID.to_string() == "AAAAAAAAAAAAAAAAAAAAAQ");

Tuple Fields

0: Uuid

Implementations

impl KafkaUuid

pub const ZERO: Self

The id that stands for a null or empty id (Kafka’s ZERO_UUID).

pub const ONE: Self

The reserved id with value one (Kafka’s ONE_UUID).

pub const METADATA_TOPIC_ID: Self = Self::ONE

The topic id of the metadata topic, __cluster_metadata.

pub const RESERVED: [Self; 2]

The ids that random never returns (Kafka’s Uuid.RESERVED).

pub const DIRECTORY_MIGRATING: Self = Self::ZERO

The directory id of a replica that is in a log directory that the broker has not yet reported (Kafka’s DirectoryId.MIGRATING).

pub const DIRECTORY_UNASSIGNED: Self = Self::ONE

The directory id of a replica that is not yet placed in a log directory (Kafka’s DirectoryId.UNASSIGNED).

pub const DIRECTORY_LOST: Self

The directory id of a replica in an offline log directory that has no known id (Kafka’s DirectoryId.LOST).

pub const fn from_bits(most_significant: i64, least_significant: i64) -> Self

Builds an id from its two halves, as Kafka’s Uuid(long, long) does.

pub const fn get(self) -> Uuid

The inner uuid::Uuid.

pub const fn most_significant_bits(self) -> i64

The most significant 64 bits, as Kafka’s getMostSignificantBits returns them.

pub const fn least_significant_bits(self) -> i64

The least significant 64 bits, as Kafka’s getLeastSignificantBits returns them.

pub fn random() -> Self

Returns a random version 4 id, as Kafka’s Uuid.randomUuid does.

The result is never in RESERVED, and its string form never starts with -. A leading - would make a command-line parser read the id as an option.

pub fn random_directory_id() -> Self

Returns a random log-directory id, as Kafka’s DirectoryId.random does.

The result obeys the rules of random, and it is never one of the 100 reserved directory ids (see is_reserved_directory_id).

pub fn is_reserved(self) -> bool

Returns true for an id in RESERVED.

pub const fn is_reserved_directory_id(self) -> bool

Returns true for one of the 100 lowest ids, which Kafka reserves as directory ids (Kafka’s DirectoryId.reserved).

pub fn parse_kafka_or_hyphenated(input: &str) -> Result<Self, KafkaUuidError>

Parses the Kafka form, or the 36-character hyphenated hex form.

Kafka’s Uuid.fromString rejects the hyphenated form, so FromStr does too. Krabka’s own tools also accept it, and they parse through this function. An input with a - at each of the four hyphen positions of a 36-character string is parsed as hex. Any other input is parsed as FromStr parses it.

Errors

Returns KafkaUuidError::Hyphenated when the input has the shape of the hyphenated form but is not valid hex. Otherwise returns the error of FromStr.

Trait Implementations

impl Clone for KafkaUuid

fn clone(&self) -> KafkaUuid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KafkaUuid

impl Debug for KafkaUuid

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

Formats the value using the given formatter.

impl Default for KafkaUuid

fn default() -> KafkaUuid

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KafkaUuid

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

Deserialize this value from the given Serde deserializer.

impl Display for KafkaUuid

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

Formats the value using the given formatter.

impl Eq for KafkaUuid

impl From<KafkaUuid> for Uuid

fn from(value: KafkaUuid) -> Self

Converts to this type from the input type.

impl From<Uuid> for KafkaUuid

fn from(value: Uuid) -> Self

Converts to this type from the input type.

impl FromStr for KafkaUuid

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

Parses the Kafka form, as Kafka’s Uuid.fromString does.

type Err = KafkaUuidError

The associated error which can be returned from parsing.

impl Hash for KafkaUuid

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 Ord for KafkaUuid

fn cmp(&self, other: &Self) -> 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 PartialEq for KafkaUuid

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

fn partial_cmp(&self, other: &Self) -> 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 Serialize for KafkaUuid

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KafkaUuid