Struct sage_auth::auth::AuthenticateBuilder

pub struct AuthenticateBuilder<'a> { /* fields omitted */ }

AuthenticateBuilder is used to generate a authenticate request

For example:

let resp = AuthenticateBuilder::new()
    .username("USERNAME")
    .password("PASSWORD")
    .request()
    .await?;

Methods

impl<'a> AuthenticateBuilder<'a>

pub fn new() -> AuthenticateBuilder<'a>

pub fn username(&mut self, username: &'a str) -> &mut AuthenticateBuilder<'a>

Set username

pub fn password(&mut self, password: &'a str) -> &mut AuthenticateBuilder<'a>

Set password

pub fn client_token(
    &mut self,
    client_token: Uuid
) -> &mut AuthenticateBuilder<'a>

Specify a client token. If is not provided, it will be generated when making a request.

pub fn request_user(&mut self) -> &mut AuthenticateBuilder<'a>

Set to request user profile. If set, AuthenticateResponse will contain the user profile.

pub fn agent_name(
    &mut self,
    agent_name: &'a str
) -> &mut AuthenticateBuilder<'a>

Set agent name, default is Minecraft

pub fn agent_version(
    &mut self,
    agent_version: i32
) -> &mut AuthenticateBuilder<'a>

Set agent version, default is 1

pub fn server<T: IntoUrl>(
    &mut self,
    server: T
) -> Result<&mut AuthenticateBuilder<'a>>

Set base url, default is https://authserver.mojang.com.

pub fn endpoint(&mut self, endpoint: &'a str) -> &mut AuthenticateBuilder<'a>

set endpoint, default is /authenticate.

pub async fn request<'_>(&'_ mut self) -> Result<AuthenticateResponse>

Make a request with the given parameters.

Trait Implementations

impl<'_> Default for AuthenticateBuilder<'_>

fn default() -> AuthenticateBuilder<'static>

Returns the "default value" for a type.