Crate neos

source ·
Expand description

Typed models for Neos’ API with serde support.

Featuring time for date times and strum for better enums.

Actual documentation of the API is lacking, and the API is still changing too. Thus this crate can’t guarantee that it’s necessarily fully correct. Some of the types are based solely on educated guesses.

Check out https://wiki.neosvr.com/docfx/api if you’re not using Rust and just want to learn about the API.

Example usage

extern crate serde_json;

// Normally you'd get the data by calling the API
let data = r#"{
        "username": "ljoonal",
        "userID": "U-ljoonal",
        "isPresent": true,
        "outputDevice": 2
     }"#;

let session_user: neos::model::SessionUser =
	serde_json::from_str(data).unwrap();

assert_eq!(session_user.output_device, neos::model::OutputDevice::Screen);

Modules

  • api_clienthttp_client
    An optional API client feature using reqwest
  • Wrappers for Neos IDs.
  • Models of the responses of Neos’ API.
  • Models of the queries for Neos’ API.

Structs

  • An URI for a Neos asset such as a profile picture.