[][src]Struct irc3::client::Client

pub struct Client { /* fields omitted */ }

An IRC client wrapped around a TCP socket.

To interact with the client, the [read_message] and [write_message] functions have been provided to interact with the connected server.

Methods

impl Client[src]

pub async fn new<'_, S: AsRef<str> + ?Sized>(
    dest: &'_ S
) -> Result<Client, IoError>
[src]

Create a new Client.

The client will establish a connection to a server and do nothing else. The function expects a resolvable IP / DOMAIN in the form <ip>[:<port>] where <port> is optional (the default port for plaintext IRC is 6667).

pub async fn read_message<'_>(
    &'_ mut self
) -> Result<Message, MessageTransportError>
[src]

Deprecated since 0.2.0:

use the Stream/Sink API instead

Read an IRC message directly from the underlying socket

pub async fn write_message<'_>(
    &'_ mut self,
    m: Message
) -> Result<(), MessageTransportError>
[src]

Deprecated since 0.2.0:

use the Stream/Sink API instead

Write an IRC message directly to the underlying socket

Trait Implementations

impl Sink<Message> for Client[src]

type Error = MessageTransportError

The type of value produced by the sink when an error occurs.

impl Stream for Client[src]

type Item = Result<Message, MessageTransportError>

Values yielded by the stream.

Auto Trait Implementations

impl RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl UnwindSafe for Client

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized
[src]

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]