Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

Contains the socket to connect to VRChat OSC to send messages.

Can either be created with a ClientBuilder or Client::new

Implementations§

Source§

impl Client

Source

pub fn new(server_address: SocketAddr, client_socket: UdpSocket) -> Self

Create a Client without ClientBuilder. client_socket.

Source§

impl Client

Source

pub fn change_server_address(&mut self, new_address: SocketAddr) -> Result<()>

Change the address (ip and port) that the client sends OSC messages to.

Err if the socket could not connect to the new address

Source

pub fn change_server_ip(&mut self, new_ip: IpAddr) -> Result<()>

Change the ip that the client sends OSC messages to.

Err if the socket could not connect to the new address.

Source

pub fn change_server_port(&mut self, new_port: u16) -> Result<()>

Change the port that the client sends OSC messages to.

Err if the socket could not connect to the new address.

Source

pub fn typing_indicator(&self, toggle: bool) -> Result<()>

Set the visibility of the typing indicator.

Err if the client is not connected to anything

Panics if it could not encode an OscMessage (Should not happen, and if it does, not much a downstream user can do about it anyway)

Source

pub fn send_message(&self, msg: &str, keyboard: bool, sfx: bool) -> Result<()>

Send a chatbox message.

Err if the client is not connected to anything.

Panics if it could not encode an OscMessage (Should not happen, and if it does, not much a downstream user can do about it anyway)

Trait Implementations§

Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl UnwindSafe for Client

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.