Struct lighthouse_client::Lighthouse

pub struct Lighthouse<S> { /* private fields */ }

A connection to the lighthouse server for sending requests and receiving events.

Implementations

impl<S> Lighthouse<S>where
    S: Stream<Item = Result<Message>> + Sink<Message, Error = Error> + Unpin + Send + 'static,

pub fn new<W>(web_socket: S, authentication: Authentication) -> Result<Self>where
    W: Spawner,

Connects to the lighthouse using the given credentials. Asynchronously runs a receive loop using the provided spawner.

pub async fn put_model(&mut self, frame: Frame) -> Result<()>

Replaces the user’s lighthouse model with the given frame.

pub async fn stream_model(&mut self) -> Result<Receiver<ServerMessage>>

Requests a stream of events (including key/controller events) for the user’s lighthouse model.

pub async fn put(
    &mut self,
    path: impl IntoIterator<Item = &str> + Debug,
    payload: Payload
) -> Result<()>

Performs a PUT request to the given path with the given payload.

pub async fn request(
    &mut self,
    verb: &str,
    path: impl IntoIterator<Item = &str> + Debug,
    payload: Payload
) -> Result<()>

Performs a single request to the given path with the given payload.

pub async fn stream(
    &mut self,
    path: impl IntoIterator<Item = &str> + Debug,
    payload: Payload
) -> Result<Receiver<ServerMessage>>

Performs a STREAM request to the given path with the given payload.