Struct renetcode::ConnectToken

pub struct ConnectToken { /* private fields */ }

A public connect token that the client receives to start connecting to the server. How the client receives ConnectToken is up to you, could be from a matchmaking system or from a call to a REST API as an example.

Implementations

impl ConnectToken

pub fn generate(
    current_time: Duration,
    protocol_id: u64,
    expire_seconds: u64,
    client_id: u64,
    timeout_seconds: i32,
    server_addresses: Vec<SocketAddr>,
    user_data: Option<&[u8; 256]>,
    private_key: &[u8; 32]
) -> Result<Self, TokenGenerationError>

Generate a token to be sent to an client. The user data is available to the server after an successfull conection. The private key and the protocol id must be the same used in server.

pub fn write(&self, writer: &mut impl Write) -> Result<(), Error>

pub fn read(src: &mut impl Read) -> Result<Self, NetcodeError>

Trait Implementations

impl Clone for ConnectToken

fn clone(&self) -> ConnectToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectToken

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

Formats the value using the given formatter.

impl PartialEq<ConnectToken> for ConnectToken

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

impl StructuralEq for ConnectToken

impl StructuralPartialEq for ConnectToken