Enum uuid_mc::PlayerUuid

pub enum PlayerUuid {
    Online(OnlineUuid),
    Offline(OfflineUuid),
}

An enum that can represent both kinds of UUIDs.

Variants

Online(OnlineUuid)

Offline(OfflineUuid)

Implementations

impl PlayerUuid

pub fn new_with_online_username(username: &str) -> Result<Self, Error>

Creates a new instance using the username of an online player, by polling the Mojang API.

Errors

If there is no user that corresponds to the provided username, an Error::InvalidUsername is returned.
Otherwise, an Error::Transport can be returned in case of network failure.

Examples

To fetch the UUID of an online user:

use uuid::Uuid;
use uuid_mc::PlayerUuid;

let uuid = PlayerUuid::new_with_online_username("Notch")?;
let uuid = uuid.as_uuid();
let expected = Uuid::try_parse("069a79f4-44e9-4726-a5be-fca90e38aaf5")?;
assert_eq!(uuid, &expected);

pub fn new_with_offline_username(username: &str) -> Self

Creates a new instance using the username of an offline player.

Examples

To fetch the UUID of an offline user:

use uuid::Uuid;
use uuid_mc::PlayerUuid;

let uuid = PlayerUuid::new_with_offline_username("boolean_coercion");
let uuid = uuid.as_uuid();
let expected = Uuid::try_parse("db62bdfb-eddc-3acc-a14e-c703aba52549")?;
assert_eq!(uuid, &expected);

pub fn new_with_uuid(uuid: Uuid) -> Result<Self, Error>

Creates a new instance using an already existing Uuid.

Errors

In case the provided Uuid is neither offline (v3) or online (v4), an Error::InvalidUuid is returned.

Examples

To test whether a given Uuid is of the offline or online format:

use uuid::Uuid;
use uuid_mc::PlayerUuid;

let uuid_offline = Uuid::try_parse("db62bdfb-eddc-3acc-a14e-c703aba52549")?;
let uuid_online = Uuid::try_parse("61699b2e-d327-4a01-9f1e-0ea8c3f06bc6")?;
let player_uuid_offline = PlayerUuid::new_with_uuid(uuid_offline)?;
let player_uuid_online = PlayerUuid::new_with_uuid(uuid_online)?;

assert!(matches!(player_uuid_offline, PlayerUuid::Offline(_)));
assert!(matches!(player_uuid_online, PlayerUuid::Online(_)));

pub fn as_uuid(&self) -> &Uuid

Returns the inner Uuid.

pub fn as_bytes(&self) -> &[u8; 16]

Returns the inner UUID, as a byte array. This is just a convenience function around self.as_uuid().as_bytes().

pub fn unwrap_offline(self) -> OfflineUuid

Similar to Result::unwrap, this function returns the inner OfflineUuid.

Panics

If the inner UUID is not an offline one.

pub fn unwrap_online(self) -> OnlineUuid

Similar to Result::unwrap, this function returns the inner OnlineUuid.

Panics

If the inner UUID is not an online one.

pub fn offline(self) -> Option<OfflineUuid>

Returns the contained OfflineUuid if it is present, or None otherwise.

pub fn online(self) -> Option<OnlineUuid>

Returns the contained OnlineUuid if it is present, or None otherwise.

Trait Implementations

impl Clone for PlayerUuid

fn clone(&self) -> PlayerUuid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlayerUuid

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlayerUuid

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

Deserialize this value from the given Serde deserializer.

impl From<PlayerUuid> for Uuid

fn from(other: PlayerUuid) -> Self

Converts to this type from the input type.

impl Hash for PlayerUuid

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 PlayerUuid

fn cmp(&self, other: &PlayerUuid) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PlayerUuid> for PlayerUuid

fn eq(&self, other: &PlayerUuid) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<PlayerUuid> for PlayerUuid

fn partial_cmp(&self, other: &PlayerUuid) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for PlayerUuid

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

Serialize this value into the given Serde serializer.

impl TryFrom<Uuid> for PlayerUuid

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Uuid) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PlayerUuid

impl Eq for PlayerUuid

impl StructuralEq for PlayerUuid

impl StructuralPartialEq for PlayerUuid