Struct Register

pub struct Register<O> {
    pub password: fn(&O) -> Option<Line<'static>>,
    pub username: fn(&O) -> User<'static>,
    pub user_p1: fn(&O) -> Arg<'static>,
    pub user_p2: fn(&O) -> Arg<'static>,
    pub realname: fn(&O) -> Line<'static>,
    pub nicks: fn(&O) -> Box<dyn NickGen>,
    pub caps: fn(&O) -> Box<dyn CapFn>,
    pub auth: fn(&O) -> (SaslQueue, bool),
}

Available on crate feature client only.

Client logic for the connection registration process.

Consider using the register_as_bot(), register_as_client(), or register_as_custom() functions to instantiate one of these.

The handler returned by using this type signals completion over its channel. Most of the useful data about client registration is added to the client as shared state. In particular, connection statistics and the MOTD are NOT stored, and should be read using a different handler.

Fields

password: fn(&O) -> Option<Line<'static>>

Returns the server password, if any.

username: fn(&O) -> User<'static>

Returns the username to use for connection.

user_p1: fn(&O) -> Arg<'static>

Returns the value used for the first unused USER parameter.

For older IRC software, this parameter is not actually unusused. RFC1459 specifies that this should be the connecting system’s hostname, while RFC2812 specifies that this should be a decimal integer whose bits are used to set user modes on connection.

user_p2: fn(&O) -> Arg<'static>

Returns the value used for the second unused USER parameter.

For older IRC software, this parameter is not actually unusused. RFC1459 specifies that this should be the name of the server being connected to.

realname: fn(&O) -> Line<'static>

Returns the realname to use for connection.

nicks: fn(&O) -> Box<dyn NickGen>

Creates a nick generator.

caps: fn(&O) -> Box<dyn CapFn>

Returns a boxed CapFn that provides a set of capabilities to require, given a set of available capabilities.

These capabilities will be requested from the server, except for sts which is special-cased to never be requested, only checked for presence.

auth: fn(&O) -> (SaslQueue, bool)

Returns a SaslQueue to attempt and whether to close the connection on non-authentication.

Implementations

impl<O> Register<O>

pub fn register_msgs( &self, opts: &O, sink: impl ClientMsgSink<'static>, ) -> (Nick<'static>, Option<Box<dyn NickGen>>)

Sends the initial burst of messages for connection registration. Also returns the nickname used and a generator for fallback nicknames.

Errors

Errors only if retrieving the server password errors.

impl<O> Register<O>

pub fn handler(&self, opts: &O, sink: impl ClientMsgSink<'static>) -> Handler

Sends the initial burst of messages for connection registration. Also returns a Handler to perform the rest of the connection registration.

Trait Implementations

impl<O: Clone> Clone for Register<O>

fn clone(&self) -> Register<O>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, O> MakeHandler<&'a O> for &'a Register<O>

type Value = Result<(), HandlerError>

The type of values yielded by the handler.

type Error = Infallible

The type of errors that can result while creating the handler.

type Receiver<Spec: ChannelSpec> = <Spec as ChannelSpec>::Oneshot<<&'a Register<O> as MakeHandler<&'a O>>::Value>

The type of the receiver half of the preferred channel type.

fn make_handler( self, _: &ClientState, queue: QueueEditGuard<'_>, opts: &'a O, ) -> Result<Box<dyn Handler<Value = Self::Value>>, Self::Error>

Converts T into a Handler and queues messages.

fn make_channel<Spec: ChannelSpec>( spec: &Spec, ) -> (Box<dyn Sender<Value = Self::Value> + Send>, Self::Receiver<Spec>)

Creates an instance of the preferred channel type for a given channel spec.