Struct PasswordProtocolExtension

pub struct PasswordProtocolExtension {
    pub username: String,
    pub password: String,
    /* private fields */
}

Password protocol extension.

Passwords are sent in plain text!! This extension will panic when encoding if the username’s length does not fit within a u8 or the password’s length does not fit within a u16.

Fields

username: String

The username to log in with.

This string’s length must fit within a u8.

password: String

The password to log in with.

This string’s length must fit within a u16.

Implementations

impl PasswordProtocolExtension

pub const ID: u8 = 2u8

Password protocol extension ID.

pub fn new_server() -> Self

Create a new password protocol extension for the server.

This signifies that the server requires a password.

pub fn new_client(username: String, password: String) -> Self

Create a new password protocol extension for the client, with a username and password.

The username’s length must fit within a u8. The password’s length must fit within a u16.

Trait Implementations

impl Clone for PasswordProtocolExtension

fn clone(&self) -> PasswordProtocolExtension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PasswordProtocolExtension

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

Formats the value using the given formatter.

impl From<PasswordProtocolExtension> for AnyProtocolExtension

fn from(value: PasswordProtocolExtension) -> Self

Converts to this type from the input type.

impl ProtocolExtension for PasswordProtocolExtension

fn get_id(&self) -> u8

Get the protocol extension ID.

fn get_supported_packets(&self) -> &'static [u8]

Get the protocol extension’s supported packets.

fn encode(&self) -> Bytes

Encode self into Bytes.

fn handle_handshake<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, _: &'life1 mut dyn WebSocketRead, _: &'life2 LockedWebSocketWrite, ) -> Pin<Box<dyn Future<Output = Result<(), WispError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handle the handshake part of a Wisp connection.

fn handle_packet<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, __arg1: Bytes, _: &'life1 mut dyn WebSocketRead, _: &'life2 LockedWebSocketWrite, ) -> Pin<Box<dyn Future<Output = Result<(), WispError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Handle receiving a packet.

fn box_clone(&self) -> Box<dyn ProtocolExtension + Sync + Send>

Clone the protocol extension.