[−][src]Struct twitch_irc::TwitchIRCClient
A send-only handle to control the Twitch IRC Client.
Implementations
impl<T: Transport, L: LoginCredentials> TwitchIRCClient<T, L>
[src]
pub fn new(
config: ClientConfig<L>
) -> (UnboundedReceiver<ServerMessage>, TwitchIRCClient<T, L>)
[src]
config: ClientConfig<L>
) -> (UnboundedReceiver<ServerMessage>, TwitchIRCClient<T, L>)
Create a new client from the given configuration.
Note this method is not side-effect-free - a background task will be spawned as a result of calling this function.
impl<T: Transport, L: LoginCredentials> TwitchIRCClient<T, L>
[src]
pub async fn connect<'_>(&'_ self)
[src]
Connect to Twitch IRC without joining any channels.
You typically do not need to call this method. This is only provided for the rare
case that one would only want to receive incoming whispers without joining channels
or ever sending messages out. If your application joins channels during startup,
calling .connect()
is superfluous, as the client will automatically open the necessary
connections when you join channels or send messages.
pub async fn send_message<'_>(
&'_ self,
message: IRCMessage
) -> Result<(), Error<T, L>>
[src]
&'_ self,
message: IRCMessage
) -> Result<(), Error<T, L>>
Send an arbitrary IRC message to one of the connections in the connection pool.
An error is returned in case the message could not be sent over the picked connection.
pub async fn privmsg<'_>(
&'_ self,
channel_login: String,
message: String
) -> Result<(), Error<T, L>>
[src]
&'_ self,
channel_login: String,
message: String
) -> Result<(), Error<T, L>>
Send a PRIVMSG
-type IRC message to a Twitch channel. The message
can be a normal
chat message or a chat command like /ban
or similar.
If you want to just send a normal chat message, say()
should be preferred since it
prevents commands like /ban
from accidentally being executed.
pub async fn say<'_>(
&'_ self,
channel_login: String,
message: String
) -> Result<(), Error<T, L>>
[src]
&'_ self,
channel_login: String,
message: String
) -> Result<(), Error<T, L>>
Say a chat message in the given Twitch channel.
This method automatically prevents commands from being executed. For example `say("a_channel", "/ban a_user") would not actually ban a user, instead it would send that exact message as a normal chat message instead.
No particular filtering is performed on the message. If the message is too long for chat, it will not be cut short or split into multiple messages (what happens is determined by the behaviour of the Twitch IRC server).
pub fn join(&self, channel_login: String)
[src]
Join the given Twitch channel (When a channel is joined, the client will receive messages sent to it).
The client will internally ensure that there has always been at least an attempt to join this channel. However this does not necessarily mean the join is always successful.
If the given channel_login
does not exist (or is suspended) then the IRC server
will ignore the JOIN
and you will not be joined to the given channel (what channel would
you even expect to join if the channel does not exist?).
However, the client listens for a server-side confirmation to this JOIN
command.
If the server confirms that the JOIN
was successful, then the client saves this information.
This information can be queried using get_channel_status()
.
If you later issue another join()
call, and the server previously confirmed the successful
joining of channel_login
, then no message will be sent out.
However if the server did not confirm the successful JOIN
command previously, then the
JOIN
is attempted again.
You can use this mechanism to e.g. periodically re-try JOIN
ing a given channel if
joining to freshly created channels or freshly renamed channels is a concern in your application.
Another note on Twitch behaviour: If a channel gets suspended, the JOIN
membership stays
active as long as the connection with that JOIN
membership stays active. For this reason,
there is no special logic or handling required for when a channel gets suspended.
(The JOIN
membership in that channel will continue to count as confirmed for as long
as the connection stays alive. If the connection fails, the "confirmed" status for that
channel is reset, and the client will automatically attempt to re-join that channel on a
different or new connection.
Unless an answer is again received by the server, the join()
will then make attempts again
to join that channel.
pub fn set_wanted_channels(&self, channels: HashSet<String>)
[src]
Instruct the client to only be connected to these channels. Channels currently joined but not in the given set are parted, and channels in the set that are not currently joined are joined.
pub async fn get_channel_status<'_>(
&'_ self,
channel_login: String
) -> (bool, bool)
[src]
&'_ self,
channel_login: String
) -> (bool, bool)
Query the client for what status a certain channel is in.
Returns two booleans: The first indicates whether a channel is wanted
. This is true
if the last operation for this channel was a join()
method, or alternatively whether
it was included in the set of channels in a set_wanted_channels
call.
The second boolean indicates whether this channel is currently joined server-side.
(This is purely based on JOIN
and PART
messages being received from the server).
Note that any combination of true
and false
is possible here.
For example, (true, false)
could indicate that the JOIN
message to join this channel is currently
being sent or already sent, but no response confirming the JOIN
has been received yet.
Note this status can also mean that the server did not answer the JOIN
request because
the channel did not exist/was suspended or similar conditions.
(false, true)
might on the other hand (similarly) that a PART
message is sent but not
answered yet by the server.
(true, true)
confirms that the channel is currently successfully joined in a normal fashion.
(false, false)
is returned for a channel that has not been joined previously at all
or where a previous PART
command has completed.
pub fn part(&self, channel_login: String)
[src]
Part (leave) a channel, to stop receiving messages sent to that channel.
This has the same semantics as join()
. Similarly, a part()
call will have no effect
if the channel is not currently joined.
pub async fn ping<'_>(&'_ self) -> Result<(), Error<T, L>>
[src]
Ping a random connection. This does not await the PONG
response from Twitch.
The future resolves once the PING
command is sent to the wire.
An error is returned in case the message could not be sent over the picked connection.
Trait Implementations
impl<T: Transport, L: LoginCredentials> Clone for TwitchIRCClient<T, L>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Debug + Transport, L: Debug + LoginCredentials> Debug for TwitchIRCClient<T, L>
[src]
Auto Trait Implementations
impl<T, L> !RefUnwindSafe for TwitchIRCClient<T, L>
impl<T, L> Send for TwitchIRCClient<T, L> where
<T as Transport>::ConnectError: Send,
<L as LoginCredentials>::Error: Send,
<T as Transport>::IncomingError: Send,
<T as Transport>::OutgoingError: Send,
<T as Transport>::ConnectError: Send,
<L as LoginCredentials>::Error: Send,
<T as Transport>::IncomingError: Send,
<T as Transport>::OutgoingError: Send,
impl<T, L> Sync for TwitchIRCClient<T, L> where
<T as Transport>::ConnectError: Send,
<L as LoginCredentials>::Error: Send,
<T as Transport>::IncomingError: Send,
<T as Transport>::OutgoingError: Send,
<T as Transport>::ConnectError: Send,
<L as LoginCredentials>::Error: Send,
<T as Transport>::IncomingError: Send,
<T as Transport>::OutgoingError: Send,
impl<T, L> Unpin for TwitchIRCClient<T, L>
impl<T, L> !UnwindSafe for TwitchIRCClient<T, L>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,