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::{Deserialize, Result, make_place};
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                _ => <dyn Visitor>::ignore(),
77            })
78        }
79
80        fn deser_default() -> Self {
81            Self {
82                active: Deserialize::default(),
83                id: Deserialize::default(),
84                livemode: Deserialize::default(),
85                lookup_key: Deserialize::default(),
86                metadata: Deserialize::default(),
87                name: Deserialize::default(),
88            }
89        }
90
91        fn take_out(&mut self) -> Option<Self::Out> {
92            let (
93                Some(active),
94                Some(id),
95                Some(livemode),
96                Some(lookup_key),
97                Some(metadata),
98                Some(name),
99            ) = (
100                self.active,
101                self.id.take(),
102                self.livemode,
103                self.lookup_key.take(),
104                self.metadata.take(),
105                self.name.take(),
106            )
107            else {
108                return None;
109            };
110            Some(Self::Out { active, id, livemode, lookup_key, metadata, name })
111        }
112    }
113
114    impl Map for Builder<'_> {
115        fn key(&mut self, k: &str) -> Result<&mut dyn Visitor> {
116            self.builder.key(k)
117        }
118
119        fn finish(&mut self) -> Result<()> {
120            *self.out = self.builder.take_out();
121            Ok(())
122        }
123    }
124
125    impl ObjectDeser for EntitlementsFeature {
126        type Builder = EntitlementsFeatureBuilder;
127    }
128
129    impl FromValueOpt for EntitlementsFeature {
130        fn from_value(v: Value) -> Option<Self> {
131            let Value::Object(obj) = v else {
132                return None;
133            };
134            let mut b = EntitlementsFeatureBuilder::deser_default();
135            for (k, v) in obj {
136                match k.as_str() {
137                    "active" => b.active = FromValueOpt::from_value(v),
138                    "id" => b.id = FromValueOpt::from_value(v),
139                    "livemode" => b.livemode = FromValueOpt::from_value(v),
140                    "lookup_key" => b.lookup_key = FromValueOpt::from_value(v),
141                    "metadata" => b.metadata = FromValueOpt::from_value(v),
142                    "name" => b.name = FromValueOpt::from_value(v),
143                    _ => {}
144                }
145            }
146            b.take_out()
147        }
148    }
149};
150#[cfg(feature = "serialize")]
151impl serde::Serialize for EntitlementsFeature {
152    fn serialize<S: serde::Serializer>(&self, s: S) -> Result<S::Ok, S::Error> {
153        use serde::ser::SerializeStruct;
154        let mut s = s.serialize_struct("EntitlementsFeature", 7)?;
155        s.serialize_field("active", &self.active)?;
156        s.serialize_field("id", &self.id)?;
157        s.serialize_field("livemode", &self.livemode)?;
158        s.serialize_field("lookup_key", &self.lookup_key)?;
159        s.serialize_field("metadata", &self.metadata)?;
160        s.serialize_field("name", &self.name)?;
161
162        s.serialize_field("object", "entitlements.feature")?;
163        s.end()
164    }
165}
166impl stripe_types::Object for EntitlementsFeature {
167    type Id = stripe_shared::EntitlementsFeatureId;
168    fn id(&self) -> &Self::Id {
169        &self.id
170    }
171
172    fn into_id(self) -> Self::Id {
173        self.id
174    }
175}
176stripe_types::def_id!(EntitlementsFeatureId);
stripe_shared/entitlements_feature.rs

stripe_shared/
entitlements_feature.rs
