Struct showdown::SendMessage
source · pub struct SendMessage(/* private fields */);
Implementations§
source§impl SendMessage
impl SendMessage
sourcepub fn global_command(command: impl Display) -> Self
pub fn global_command(command: impl Display) -> Self
Creates a global command.
Example
use futures::{SinkExt, StreamExt};
use showdown::message::{Kind, QueryResponse};
use showdown::{Result, RoomId, SendMessage, Stream};
#[tokio::main]
async fn main() -> Result<()> {
let mut stream = Stream::connect("showdown").await?;
stream.send(SendMessage::global_command("cmd rooms")).await?;
while let Some(received) = stream.next().await {
if let Kind::QueryResponse(QueryResponse::Rooms(rooms)) = received?.kind() {
assert!(rooms
.official
.iter()
.any(|room| room.title == "Tournaments"));
return Ok(());
}
}
panic!("Server didn't provide a list of rooms")
}
sourcepub fn chat_message(room_id: RoomId<'_>, message: impl Display) -> Self
pub fn chat_message(room_id: RoomId<'_>, message: impl Display) -> Self
Creates a chat room message.
sourcepub fn chat_command(room_id: RoomId<'_>, command: impl Display) -> Self
pub fn chat_command(room_id: RoomId<'_>, command: impl Display) -> Self
Creates a command that executes in a chat room.
Examples
use futures::{SinkExt, StreamExt};
use showdown::message::{Kind, QueryResponse};
use showdown::{Result, RoomId, SendMessage, Stream};
#[tokio::main]
async fn main() -> Result<()> {
let mut stream = Stream::connect("showdown").await?;
stream.send(SendMessage::global_command("join lobby")).await?;
stream.send(SendMessage::chat_command(RoomId::LOBBY, "roomdesc")).await;
while let Some(message) = stream.next().await {
if let Kind::Html(html) = message?.kind() {
assert!(html.contains("Relax here amidst the chaos."));
return Ok(());
}
}
panic!("Server didn't provide a room description")
}
pub fn broadcast_command(room_id: RoomId<'_>, command: impl Display) -> Self
Trait Implementations§
source§impl Clone for SendMessage
impl Clone for SendMessage
source§fn clone(&self) -> SendMessage
fn clone(&self) -> SendMessage
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for SendMessage
impl Debug for SendMessage
source§impl PartialEq<SendMessage> for SendMessage
impl PartialEq<SendMessage> for SendMessage
source§fn eq(&self, other: &SendMessage) -> bool
fn eq(&self, other: &SendMessage) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Sink<SendMessage> for Stream
impl Sink<SendMessage> for Stream
source§fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
Attempts to prepare the
Sink
to receive a value. Read moresource§fn start_send(self: Pin<&mut Self>, item: SendMessage) -> Result<()>
fn start_send(self: Pin<&mut Self>, item: SendMessage) -> Result<()>
Begin the process of sending a value to the sink.
Each call to this function must be preceded by a successful call to
poll_ready
which returned Poll::Ready(Ok(()))
. Read moreimpl Eq for SendMessage
impl StructuralEq for SendMessage
impl StructuralPartialEq for SendMessage
Auto Trait Implementations§
impl RefUnwindSafe for SendMessage
impl Send for SendMessage
impl Sync for SendMessage
impl Unpin for SendMessage
impl UnwindSafe for SendMessage
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.