feat: Add unstable feature flag

Author: caleb-leinz

Cargo.toml

@@ -24,3 +24,4 @@ time = { version = "0.3.36", features = ["macros"] }
 
 [features]
 serde = ["dep:serde", "dep:serde_with", "url/serde", "ipnet/json", "time/serde-human-readable"]
+unstable = []

README.md

@@ -11,3 +11,17 @@ of the [Freedom API](https://github.com/ATLAS-Space-Operations/rust-freedom-api)
 In addition, the library exposes a single trait `Hateoas`. This is
 useful for navigating the
 [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) structure of the API.
+
+## Unstable Flag
+
+By default, all public structs in the crate are marked
+`non_exhaustive`. This is because we may--at any time--add a field to
+one or more of the structs, and this should not constitute a breaking
+change for users.
+
+However, for users who would like to construct the models for testing
+purposes or as their baseline we do provide the `unstable` feature
+flag, which disables this behavior when set.
+
+By using the `unstable` flag you accept that your construction of
+models might break between releases.

src/account.rs

@@ -20,7 +20,7 @@ use super::utils;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct AccountCidr {
     pub name: String,
     pub cidr: Ipv4Net,
@@ -40,7 +40,7 @@ impl std::ops::Deref for AccountCidr {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Tier {
     pub tier: u32,
     pub price: f32,
@@ -68,7 +68,7 @@ impl Hateoas for Tier {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Account {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub created: OffsetDateTime,

src/azel.rs

@@ -8,7 +8,7 @@ use time::OffsetDateTime;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Location {
     pub longitude: f64,
     pub latitude: f64,
@@ -21,7 +21,7 @@ pub struct Location {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Direction {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub timestamp: OffsetDateTime,
@@ -35,7 +35,7 @@ pub struct Direction {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct AzEl {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub start: OffsetDateTime,

src/band.rs

@@ -17,7 +17,7 @@ use super::utils;
 )]
 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, AsRefStr, EnumString)]
 #[strum(serialize_all = "SCREAMING_SNAKE_CASE")]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub enum BandType {
     Transmit,
     Receive,
@@ -30,7 +30,7 @@ pub enum BandType {
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, AsRefStr, EnumString)]
 #[strum(serialize_all = "SCREAMING_SNAKE_CASE")]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub enum IoHardware {
     Modem,
     Fep,
@@ -47,7 +47,7 @@ pub enum IoHardware {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct IoConfiguration {
     #[cfg_attr(feature = "serde", serde(default))]
     pub start_hex_pattern: Option<String>,
@@ -64,7 +64,7 @@ pub struct IoConfiguration {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Band {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub created: OffsetDateTime,

src/error.rs

@@ -7,7 +7,7 @@ use serde::Deserialize;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub enum Error {
     PaginatedInner,
     PaginatedListMissing,

src/gateway_licenses.rs

@@ -12,7 +12,7 @@ use time::OffsetDateTime;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct RegenerateResponse {
     pub account_id: u64,
     pub license_id: u32,
@@ -28,7 +28,7 @@ pub struct RegenerateResponse {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct VerifyResponse {
     pub valid: bool,
     pub license_id: Option<u32>,
@@ -50,7 +50,7 @@ pub struct VerifyResponse {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct View(pub Vec<ViewOne>);
 
 /// Representation of a single license associated with an account.
@@ -62,7 +62,7 @@ pub struct View(pub Vec<ViewOne>);
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct ViewOne {
     pub id: u32,
     pub account_id: u64,
@@ -92,7 +92,7 @@ pub struct ViewOne {
 )]
 #[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, AsRefStr, EnumString)]
 #[strum(serialize_all = "SCREAMING_SNAKE_CASE")]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub enum Status {
     /// License is active and can be used.
     Active,

src/pagination.rs

@@ -9,7 +9,7 @@ use url::Url;
 /// A paginated response
 #[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
 #[serde(rename_all = "camelCase")]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Paginated<T>
 where
     T: DeserializeOwned,
@@ -39,7 +39,7 @@ where
 /// Page metadata included in a paginated stream
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
 #[serde(rename_all = "camelCase")]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Page {
     pub size: u32,
     pub total_elements: u32,

src/satellite.rs

@@ -15,7 +15,7 @@ use super::utils;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct TwoLineElement {
     pub line1: String,
     pub line2: String,
@@ -28,7 +28,7 @@ pub struct TwoLineElement {
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct Satellite {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub created: OffsetDateTime,

src/satellite_configuration.rs

@@ -16,7 +16,7 @@ use super::utils;
     serde(rename_all = "camelCase")
 )]
 #[derive(Debug, Clone, PartialEq, Eq)]
-#[non_exhaustive]
+#[cfg_attr(not(feature = "unstable"), non_exhaustive)]
 pub struct SatelliteConfiguration {
     #[cfg_attr(feature = "serde", serde(with = "time::serde::iso8601"))]
     pub created: OffsetDateTime,