Struct Signald

Source
pub struct Signald { /* private fields */ }

Implementations§

Source§

impl Signald

Source

pub fn connect() -> Signald

Connect the default Signald socket

Source

pub fn connect_path(socket_path: &str) -> Self

Connect to a custom Signald socket

Source

pub fn send_request(&mut self, request: &SignaldRequest)

Send a signald request on the socket

Source

pub async fn send( &mut self, username: String, recipient_number: String, message_body: Option<String>, )

Send a message to the socket

Source

pub async fn subscribe( &mut self, username: String, ) -> Result<SignaldResponse, RecvTimeoutError>

Enable receiving user events such as received messages

Source

pub async fn unsubscribe( &mut self, username: String, ) -> Result<SignaldResponse, RecvTimeoutError>

Disable receiving user events such as received messages

Link an existing signal account

Source

pub async fn version(&mut self) -> Result<SignaldResponse, RecvTimeoutError>

Get the current signald version

Source

pub async fn list_contacts( &mut self, username: String, ) -> Result<SignaldResponse, RecvTimeoutError>

Query all the user’s contacts

Source

pub fn sync_contacts(&mut self, username: String)

Send a contact sync request to the other devices on this account

Source

pub fn get_rx(&mut self) -> BusReader<SignaldResponse>

Get a response stream that returns every received message on the socket

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.