Struct rocketchat_client_rs::RocketClient

pub struct RocketClient { /* fields omitted */ }

RocketClient represents a minimal rocketchat client which can be used to send text messages to a given webhook.

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
    	.with_channel("#test-logs")
            .execute();

Methods

impl RocketClient

pub fn new<T>(webhook: T) -> Self where
    T: Into<String>, 

pub fn with_channel<T>(&mut self, channel: T) -> &mut Self where
    T: Into<String>, 

Define the channel name where this message is to be sent

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
    	.with_channel("#test-logs")
            .execute();

pub fn with_hostname<T>(&mut self, hostname: T) -> &mut Self where
    T: Into<String>, 

Define the hostname from which this message is being sent

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
    	.with_hostname("my-machine")
            .execute();

pub fn with_text<T>(&mut self, text: T) -> &mut Self where
    T: Into<String>, 

Define text which is to be sent.

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
	.with_channel("#test-logs")
	.with_text("Hi world")
    .execute();

pub fn with_default_hostname(&mut self) -> &mut Self

Add default hostname with the message being sent

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
	.with_channel("#test-logs")
	.with_default_hostname()
    .execute();

pub fn with_botname<T>(&mut self, botname: T) -> &mut Self where
    T: Into<Option<String>>, 

Add botname with the message being sent

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
	.with_channel("#test-logs")
	.with_botname("some-bot")
    .execute();

pub fn with_emoji<T>(&mut self, emoji: T) -> &mut Self where
    T: Into<Option<String>>, 

Add emoji with the message being sent

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
	.with_channel("#test-logs")
	.with_emoji(":sos:")
    .execute();

pub fn execute(&mut self) -> Result<(), Error>

Execute the builder pattern finally after constructing the object.

Examples

Basic usage:

use rocketchat_client_rs::RocketClient;
let _response = RocketClient::new("www.facebook.com")
	.with_channel("#test-logs")
	.with_text("Hi world")
	.with_default_hostname()
    .execute();

Trait Implementations

impl Default for RocketClient

fn default() -> RocketClient

Returns the "default value" for a type.

impl Debug for RocketClient

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for RocketClient

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for RocketClient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.