Struct Connection

pub struct Connection {
    pub stream: TcpStream,
    pub password_hash_algo: PasswordHashAlgo,
    pub password_hash_iterations: u32,
    pub totp: bool,
    pub nonce: Vec<u8>,
    pub compression: Compression,
    pub escape_commands: bool,
}

A TCP connection to the WeeChat relay, along with the configuration for the connection, likely negotiated in a handshake.

Fields

stream: TcpStream

password_hash_algo: PasswordHashAlgo

password_hash_iterations: u32

totp: bool

nonce: Vec<u8>

compression: Compression

escape_commands: bool

Implementations

impl Connection

pub fn new( stream: TcpStream, handshake: Option<HandshakeCommand>, ) -> Result<Self, WeechatError>

Using the given stream and handshake arguments, attempt to establish a connection.

If a handshake is provided, this performs a handshake, so you should not attempt to send another after, but this does not perform the init regardless.

pub fn send_command<T: CommandType>( &mut self, command: &Command<T>, ) -> Result<(), WeechatError>

Send a single command on the Connection.

pub fn send_commands( &mut self, commands: &mut dyn Iterator<Item = &DynCommand>, ) -> Result<(), WeechatError>

Send a series of commands on the Connection.

pub fn get_message( &mut self, ) -> Result<Message, ParseMessageError<Error<Vec<u8>>>>

Get a response on the Connection.

Trait Implementations

impl Debug for Connection

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

Formats the value using the given formatter.