irelia

Crates.ioirelia
lib.rsirelia
version0.8.1
sourcesrc
created_at2023-01-27 13:59:04.005146
updated_at2024-09-08 23:20:09.544298
descriptionA Rust wrapper around the native LoL APIs
homepagehttps://github.com/AlsoSylv/Irelia
repositoryhttps://github.com/AlsoSylv/Irelia
max_upload_size
id769681
size1,267,473
Sylv (AlsoSylv)

documentation

https://docs.rs/irelia

README

Irelia

Crates.io Total Downloads GitHub Repo stars Crates.io Version docs.rs

Irelia is a wrapper for the local https APIs provided by riot games for LoL


[dependencies]
irelia = "0.7"

Cargo Features


This crate is designed with modularity in mind, and as such API support has been split into different cargo features.

By default, everything but the replay feature is enabled

  • ["full"] - enables support for all APIs
  • ["ws"] - enables support for the LCU websocket
  • ["in_game"] - enables support for the native in game API
  • ["batched"] - enabled the batched request system
  • ["replay"] - enables the replay API interface

Making a request to the LCU


Making a request to the LCU with irelia is simple

use irelia::{Error, RequestClient, rest::LcuClient};
use serde_json::Value;

#[tokio::main]
async fn main() {
    let request_client = RequestClient::new();
    let lcu_client = LcuClient::new(false).unwrap();
    
    let json: Result<Option<Value>, Error> = lcu_client.get("/endpoint", &request_client).await;
}

Examples


Up-to-date examples can always be found here

Commit count: 188

cargo fmt