Struct JoinOpts 

#[non_exhaustive]
pub struct JoinOpts {
    pub server_proxy: Option<Proxy>,
    pub sessionserver_proxy: Option<Proxy>,
    pub custom_server_addr: Option<ServerAddr>,
    pub custom_socket_addr: Option<SocketAddr>,
}

Optional settings when adding an account to a swarm or client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

server_proxy: Option<Proxy>

The SOCKS5 proxy that this bot will use for connecting to the Minecraft server.

sessionserver_proxy: Option<Proxy>

The SOCKS5 proxy that will be used when authenticating the bot’s join with Mojang.

This should typically be either the same as Self::server_proxy or None.

This is useful to set if a server has prevent-proxy-connections enabled.

custom_server_addr: Option<ServerAddr>

Override the server address that this specific bot will send in the handshake packet.

custom_socket_addr: Option<SocketAddr>

Override the IP and port that this specific bot will use to connect to the server.

Implementations

impl JoinOpts

pub fn new() -> Self

pub fn update(&mut self, other: &Self)

pub fn proxy(self, proxy: Proxy) -> Self

Configure the SOCKS5 proxy used for connecting to the server and for authenticating with Mojang.

To configure these separately, for example to only use the proxy for the Minecraft server and not for authentication, you may use Self::server_proxy and Self::sessionserver_proxy individually.

pub fn server_proxy(self, proxy: Proxy) -> Self

Configure the SOCKS5 proxy that will be used for connecting to the Minecraft server.

To avoid errors on servers with the “prevent-proxy-connections” option set, you should usually use Self::proxy instead.

Also see Self::sessionserver_proxy.

pub fn sessionserver_proxy(self, proxy: Proxy) -> Self

Configure the SOCKS5 proxy that this bot will use for authenticating the server join with Mojang’s API.

Also see Self::proxy and Self::server_proxy.

pub fn custom_server_addr(self, server_addr: ServerAddr) -> Self

Set the custom address that this bot will send in the handshake packet.

pub fn custom_socket_addr(self, socket_addr: SocketAddr) -> Self

Set the custom resolved address that this bot will use to connect to the server.

Trait Implementations

impl Clone for JoinOpts

fn clone(&self) -> JoinOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JoinOpts

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

Formats the value using the given formatter.

impl Default for JoinOpts

fn default() -> JoinOpts

Returns the “default value” for a type.