pep/xmpp-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

document ClientBuilder

Browse source
This commit is contained in:
lumi 2017-02-21 13:55:20 +01:00
parent d31caae5a0
commit 9abfa5f170
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/client.rs
View file

@ -14,6 +14,7 @@ use xml::reader::XmlEvent as ReaderEvent;
use std::sync::mpsc::{Receiver, channel}; use std::sync::mpsc::{Receiver, channel};
/// A builder for `Client`s.
pub struct ClientBuilder { pub struct ClientBuilder {
jid: Jid, jid: Jid,
host: Option<String>, host: Option<String>,
@ -21,6 +22,7 @@ pub struct ClientBuilder {
} }
impl ClientBuilder { impl ClientBuilder {
/// Create a new builder for an XMPP client that will connect to `jid` with default parameters.
pub fn new(jid: Jid) -> ClientBuilder { pub fn new(jid: Jid) -> ClientBuilder {
ClientBuilder { ClientBuilder {
jid: jid, jid: jid,
@ -29,16 +31,19 @@ impl ClientBuilder {
} }
} }
/// Set the host to connect to.
pub fn host(mut self, host: String) -> ClientBuilder { pub fn host(mut self, host: String) -> ClientBuilder {
self.host = Some(host); self.host = Some(host);
self self
} }
/// Set the port to connect to.
pub fn port(mut self, port: u16) -> ClientBuilder { pub fn port(mut self, port: u16) -> ClientBuilder {
self.port = port; self.port = port;
self self
} }
/// Connects to the server and returns a `Client` when succesful.
pub fn connect(self) -> Result<Client, Error> { pub fn connect(self) -> Result<Client, Error> {
let host = &self.host.unwrap_or(self.jid.domain.clone()); let host = &self.host.unwrap_or(self.jid.domain.clone());
let mut transport = SslTransport::connect(host, self.port)?; let mut transport = SslTransport::connect(host, self.port)?;