vrc 0.5.0

Unofficial rust types of VRChat's API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

#![doc(html_logo_url = "https://github.com/onlivfe/vrc_rs/raw/main/logo.png")]
//! Typed models for `VRChat`'s API.
//!
//! This is fully work in progress, and published to be able to already setup the dependencies for [onlivfe](https://onlivfe.com).
//!
//! Please see [vrchatapi](https://docs.rs/vrchatapi) for a mature implementation.
//! It does though for example represents many things as `String`s or `Option`s
//! where an `enum` would be more appropriate. It's understandable though
//! for the Openapi generated code to not align that closely with them.
//!
//! This implementation will differ in that it'll try to align more with
//! the `rust™` way. Meaning the code will rename things to be meaningful,
//! use enums for a lot of things, and manually implement some traits like
//! debug for sensitive values such as passwords.

// We use a custom `nightly` CFG to gate doc_auto_cfg to only supported
#![allow(unexpected_cfgs)]
#![cfg_attr(nightly, feature(doc_auto_cfg))]
#![deny(clippy::all)]
#![forbid(unsafe_code)]
#![deny(clippy::cargo)]
#![warn(missing_docs)]
#![deny(rustdoc::invalid_html_tags)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
// My project my choice, tabs are literally made for indentation, spaces not.
#![allow(clippy::tabs_in_doc_comments)]
// Not much can be done about it :/
#![allow(clippy::multiple_crate_versions)]
// time macro causes warnings :/
#![allow(clippy::redundant_pub_crate)]

use serde::{Deserialize, Deserializer};

pub mod id;
pub mod model;
pub mod query;

/// The version 1 VRC API
pub const API_BASE_URI: &str = "https://vrchat.com/api/1";
/// VRC API for some reason uses a static cookie key for requests
pub const API_KEY: &str = "JlE5Jldo5Jibnk5O5hTx6XVqsJu4WJ26";

time::serde::format_description!(date_format, Date, "[year]-[month]-[day]");

#[cfg(feature = "api_client")]
pub mod api_client;

/// Deals with the literal string `"none"` as `None`
fn deserialize_optional_date<'de, D>(
	deserializer: D,
) -> Result<Option<time::OffsetDateTime>, D::Error>
where
	D: Deserializer<'de>,
{
	use time::serde::rfc3339;
	#[derive(Deserialize)]
	#[serde(untagged)]
	enum MaybeNone {
		#[serde(with = "rfc3339::option")]
		Value(Option<time::OffsetDateTime>),
		NoneString(String),
	}

	// deserialize into local enum
	let value: MaybeNone = Deserialize::deserialize(deserializer)?;
	match value {
		// if parsed as T or None, return that
		MaybeNone::Value(value) => Ok(value),

		// otherwise, if value is string an "n/a", return None
		// (and fail if it is any other string)
		MaybeNone::NoneString(string) => {
			if string == "none" {
				Ok(None)
			} else {
				Err(serde::de::Error::custom("Unexpected string"))
			}
		}
	}
}