Client

Struct Client 

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

A client for sending commands to a specific LaserCube device.

Implementations§

Source§

impl Client

Source

pub async fn new( bind_ip: IpAddr, target_ip: Ipv4Addr, ) -> Result<Self, CommandError>

Create a new Client from a single target device IP (non-broadcast).

Returns a new Client or an error if the socket couldn’t be created.

§Example
use futures::StreamExt;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // First discover devices
    let bind_ip = [0, 0, 0, 0].into();
    let target_ip = [255, 255, 255, 255].into();
    let mut devices = lasercube::discover::devices(bind_ip, target_ip).await?;

    // Connect to the first device found
    if let Some(device_info) = devices.next().await {
        let client = lasercube::Client::new(bind_ip, device_info.header.ip_addr).await?;

        // Now you can send commands to the device
        let buffer_free = client.get_buffer_free().await?;
        println!("Buffer free: {buffer_free}");

        // Enable output
        client.set_output(true).await?;
    }

    Ok(())
}
Source

pub async fn send_command( &self, command: Command, ) -> Result<Response, CommandError>

Send a command to the LaserCube and wait for a response.

This method will await until a response is received.

Returns the parsed response, or an error in the case that an I/O issue occurred or an unexpected response was received.

Source

pub async fn get_buffer_free(&self) -> Result<u16, CommandError>

Get the amount of free space in the device’s buffer.

Returns the number of free points in the buffer, or an error.

Source

pub async fn set_output(&self, enable: bool) -> Result<(), CommandError>

Enable or disable laser output.

Source

pub async fn enable_buffer_size_response( &self, enable: bool, ) -> Result<(), CommandError>

Enable or disable buffer size responses on data packets.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more