Struct cobble_core::profile::Profile

source · [−]

pub struct Profile {
    pub uuid: Uuid,
    pub username: String,
    pub profile_id: String,
    pub player_name: String,
    pub microsoft_refresh_token: String,
    pub minecraft_token: String,
    pub minecraft_token_exp: OffsetDateTime,
}

Expand description

A profile used to play Minecraft in online mode. The profile is created by authenticating with Microsoft, XBoxLive, XBoxLiveSecurity and finally Minecraft.

Fields

uuid: Uuid

UUID of the profile.

username: String

XBoxLive username.

profile_id: String

Minecraft profile ID.

player_name: String

Minecraft player name.

microsoft_refresh_token: String

Microsoft refresh token.

minecraft_token: String

Minecraft access token.

minecraft_token_exp: OffsetDateTime

Minecraft refresh token.

Implementations

impl Profile

pub fn authenticate(
    client_id: String,
    client_secret: String,
    cancel: Arc<AtomicBool>
) -> CobbleResult<(String, Receiver<CobbleResult<Self>>)>

Performs the whole authentication process. This function almost immediately returns the OAuth2 URL and a receiver that receives the result of the authentication process. The authentication process is started in the background in a separate thread.

pub fn refresh(
    &mut self,
    client_id: String,
    client_secret: String
) -> CobbleResult<()>

Refreshes the Minecraft access token by refreshing the Microsoft token. It then performs the whole authentication chain:

Microsoft
XBoxLive
XBoxLiveSecurity
Minecraft

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Profile

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Profile

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

Deserialize this value from the given Serde deserializer. Read more

impl From<GProfile> for Profile

Available on crate feature gobject only.

fn from(gprofile: GProfile) -> Self

Converts to this type from the input type.

impl From<Profile> for GProfile

Available on crate feature gobject only.

fn from(profile: Profile) -> Self

Converts to this type from the input type.

impl Serialize for Profile

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for Profile

impl Send for Profile

impl Sync for Profile

impl Unpin for Profile

impl UnwindSafe for Profile

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,