stripe_shared/
entitlements_feature.rs

1/// A feature represents a monetizable ability or functionality in your system.
2/// Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
3#[derive(Clone, Debug)]
4#[cfg_attr(feature = "deserialize", derive(serde::Deserialize))]
5pub struct EntitlementsFeature {
6    /// Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
7    pub active: bool,
8    /// Unique identifier for the object.
9    pub id: stripe_shared::EntitlementsFeatureId,
10    /// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
11    pub livemode: bool,
12    /// A unique key you provide as your own system identifier. This may be up to 80 characters.
13    pub lookup_key: String,
14    /// Set of key-value pairs that you can attach to an object.
15    /// This can be useful for storing additional information about the object in a structured format.
16    pub metadata: std::collections::HashMap<String, String>,
17    /// The feature's name, for your own purpose, not meant to be displayable to the customer.
18    pub name: String,
19}
20#[doc(hidden)]
21pub struct EntitlementsFeatureBuilder {
22    active: Option<bool>,
23    id: Option<stripe_shared::EntitlementsFeatureId>,
24    livemode: Option<bool>,
25    lookup_key: Option<String>,
26    metadata: Option<std::collections::HashMap<String, String>>,
27    name: Option<String>,
28}
29
30#[allow(
31    unused_variables,
32    irrefutable_let_patterns,
33    clippy::let_unit_value,
34    clippy::match_single_binding,
35    clippy::single_match
36)]
37const _: () = {
38    use miniserde::de::{Map, Visitor};
39    use miniserde::json::Value;
40    use miniserde::{make_place, Deserialize, Result};
41    use stripe_types::miniserde_helpers::FromValueOpt;
42    use stripe_types::{MapBuilder, ObjectDeser};
43
44    make_place!(Place);
45
46    impl Deserialize for EntitlementsFeature {
47        fn begin(out: &mut Option<Self>) -> &mut dyn Visitor {
48            Place::new(out)
49        }
50    }
51
52    struct Builder<'a> {
53        out: &'a mut Option<EntitlementsFeature>,
54        builder: EntitlementsFeatureBuilder,
55    }
56
57    impl Visitor for Place<EntitlementsFeature> {
58        fn map(&mut self) -> Result<Box<dyn Map + '_>> {
59            Ok(Box::new(Builder {
60                out: &mut self.out,
61                builder: EntitlementsFeatureBuilder::deser_default(),
62            }))
63        }
64    }
65
66    impl MapBuilder for EntitlementsFeatureBuilder {
67        type Out = EntitlementsFeature;
68        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
69            Ok(match k {
70                "active" => Deserialize::begin(&mut self.active),
71                "id" => Deserialize::begin(&mut self.id),
72                "livemode" => Deserialize::begin(&mut self.livemode),
73                "lookup_key" => Deserialize::begin(&mut self.lookup_key),
74                "metadata" => Deserialize::begin(&mut self.metadata),
75                "name" => Deserialize::begin(&mut self.name),
76
77                _ => <dyn Visitor>::ignore(),
78            })
79        }
80
81        fn deser_default() -> Self {
82            Self {
83                active: Deserialize::default(),
84                id: Deserialize::default(),
85                livemode: Deserialize::default(),
86                lookup_key: Deserialize::default(),
87                metadata: Deserialize::default(),
88                name: Deserialize::default(),
89            }
90        }
91
92        fn take_out(&mut self) -> Option<Self::Out> {
93            let (
94                Some(active),
95                Some(id),
96                Some(livemode),
97                Some(lookup_key),
98                Some(metadata),
99                Some(name),
100            ) = (
101                self.active,
102                self.id.take(),
103                self.livemode,
104                self.lookup_key.take(),
105                self.metadata.take(),
106                self.name.take(),
107            )
108            else {
109                return None;
110            };
111            Some(Self::Out { active, id, livemode, lookup_key, metadata, name })
112        }
113    }
114
115    impl<'a> Map for Builder<'a> {
116        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
117            self.builder.key(k)
118        }
119
120        fn finish(&mut self) -> Result<()> {
121            *self.out = self.builder.take_out();
122            Ok(())
123        }
124    }
125
126    impl ObjectDeser for EntitlementsFeature {
127        type Builder = EntitlementsFeatureBuilder;
128    }
129
130    impl FromValueOpt for EntitlementsFeature {
131        fn from_value(v: Value) -> Option<Self> {
132            let Value::Object(obj) = v else {
133                return None;
134            };
135            let mut b = EntitlementsFeatureBuilder::deser_default();
136            for (k, v) in obj {
137                match k.as_str() {
138                    "active" => b.active = FromValueOpt::from_value(v),
139                    "id" => b.id = FromValueOpt::from_value(v),
140                    "livemode" => b.livemode = FromValueOpt::from_value(v),
141                    "lookup_key" => b.lookup_key = FromValueOpt::from_value(v),
142                    "metadata" => b.metadata = FromValueOpt::from_value(v),
143                    "name" => b.name = FromValueOpt::from_value(v),
144
145                    _ => {}
146                }
147            }
148            b.take_out()
149        }
150    }
151};
152#[cfg(feature = "serialize")]
153impl serde::Serialize for EntitlementsFeature {
154    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
155        use serde::ser::SerializeStruct;
156        let mut s = s.serialize_struct("EntitlementsFeature", 7)?;
157        s.serialize_field("active", &self.active)?;
158        s.serialize_field("id", &self.id)?;
159        s.serialize_field("livemode", &self.livemode)?;
160        s.serialize_field("lookup_key", &self.lookup_key)?;
161        s.serialize_field("metadata", &self.metadata)?;
162        s.serialize_field("name", &self.name)?;
163
164        s.serialize_field("object", "entitlements.feature")?;
165        s.end()
166    }
167}
168impl stripe_types::Object for EntitlementsFeature {
169    type Id = stripe_shared::EntitlementsFeatureId;
170    fn id(&self) -> &Self::Id {
171        &self.id
172    }
173
174    fn into_id(self) -> Self::Id {
175        self.id
176    }
177}
178stripe_types::def_id!(EntitlementsFeatureId);
stripe_shared/entitlements_feature.rs

stripe_shared/
entitlements_feature.rs
