Struct LCUWebSocket

pub struct LCUWebSocket { /* private fields */ }

Struct representing a connection to the LCU websocket

Implementations

impl LCUWebSocket

pub async fn new( f: impl Fn(Result<&[Value], Error>) -> ControlFlow<(), Flow> + Send + Sync + 'static, ) -> Result<Self, Error>

Creates a new connection to the LCU websocket

Errors

This function will return an error if the LCU is not running, or if it cannot connect to the websocket

Panics

If the auth header returned is somehow invalid (though I have not seen this in practice)

pub fn url(&self) -> &str

Returns a reference to the URL in use

pub fn auth_header(&self) -> &str

Returns a reference to the auth header in use

pub fn subscribe(&mut self, endpoint: EventType)

Subscribe to a new API event

pub fn unsubscribe(&mut self, endpoint: EventType)

Unsubscribe to a new API event

pub fn terminate(&self)

Terminate the event loop

pub fn is_finished(&self) -> bool

pub fn request(&mut self, code: RequestType, endpoint: EventType)

Allows you to make a generic request to the websocket socket