diff options
| author | mo khan <mo@mokhan.ca> | 2025-07-15 16:37:08 -0600 |
|---|---|---|
| committer | mo khan <mo@mokhan.ca> | 2025-07-17 16:30:22 -0600 |
| commit | 45df4d0d9b577fecee798d672695fe24ff57fb1b (patch) | |
| tree | 1b99bf645035b58e0d6db08c7a83521f41f7a75b /vendor/enum-ordinalize/README.md | |
| parent | f94f79608393d4ab127db63cc41668445ef6b243 (diff) | |
feat: migrate from Cedar to SpiceDB authorization system
This is a major architectural change that replaces the Cedar policy-based
authorization system with SpiceDB's relation-based authorization.
Key changes:
- Migrate from Rust to Go implementation
- Replace Cedar policies with SpiceDB schema and relationships
- Switch from envoy `ext_authz` with Cedar to SpiceDB permission checks
- Update build system and dependencies for Go ecosystem
- Maintain Envoy integration for external authorization
This change enables more flexible permission modeling through SpiceDB's
Google Zanzibar inspired relation-based system, supporting complex
hierarchical permissions that were difficult to express in Cedar.
Breaking change: Existing Cedar policies and Rust-based configuration
will no longer work and need to be migrated to SpiceDB schema.
Diffstat (limited to 'vendor/enum-ordinalize/README.md')
| -rw-r--r-- | vendor/enum-ordinalize/README.md | 190 |
1 files changed, 0 insertions, 190 deletions
diff --git a/vendor/enum-ordinalize/README.md b/vendor/enum-ordinalize/README.md deleted file mode 100644 index 2b4a41bc..00000000 --- a/vendor/enum-ordinalize/README.md +++ /dev/null @@ -1,190 +0,0 @@ -Enum Ordinalize -==================== - -[](https://github.com/magiclen/enum-ordinalize/actions/workflows/ci.yml) - -This library enables enums to not only obtain the ordinal values of their variants but also allows for the construction of enums from an ordinal value. - -## Usage - -Use `#[derive(Ordinalize)]` to have an enum (which must only has unit variants) implement the `Ordinalize` trait. - -```rust -use enum_ordinalize::Ordinalize; - -#[derive(Debug, PartialEq, Eq, Ordinalize)] -enum MyEnum { - Zero, - One, - Two, -} - -assert_eq!(3, MyEnum::VARIANT_COUNT); -assert_eq!([MyEnum::Zero, MyEnum::One, MyEnum::Two], MyEnum::VARIANTS); -assert_eq!([0i8, 1i8, 2i8], MyEnum::VALUES); - -assert_eq!(0i8, MyEnum::Zero.ordinal()); -assert_eq!(1i8, MyEnum::One.ordinal()); -assert_eq!(2i8, MyEnum::Two.ordinal()); - -assert_eq!(Some(MyEnum::Zero), MyEnum::from_ordinal(0i8)); -assert_eq!(Some(MyEnum::One), MyEnum::from_ordinal(1i8)); -assert_eq!(Some(MyEnum::Two), MyEnum::from_ordinal(2i8)); - -assert_eq!(MyEnum::Zero, unsafe { MyEnum::from_ordinal_unsafe(0i8) }); -assert_eq!(MyEnum::One, unsafe { MyEnum::from_ordinal_unsafe(1i8) }); -assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2i8) }); -``` - -#### The (Ordinal) Size of an Enum - -The ordinal value is an integer whose size is determined by the enum itself. The size of the enum increases with the magnitude of the variants' values, whether larger (or smaller if negative). - -For example, - -```rust -use enum_ordinalize::Ordinalize; - -#[derive(Debug, PartialEq, Eq, Ordinalize)] -enum MyEnum { - Zero, - One, - Two, - Thousand = 1000, -} - -assert_eq!(4, MyEnum::VARIANT_COUNT); -assert_eq!([MyEnum::Zero, MyEnum::One, MyEnum::Two, MyEnum::Thousand], MyEnum::VARIANTS); -assert_eq!([0i16, 1i16, 2i16, 1000i16], MyEnum::VALUES); - -assert_eq!(0i16, MyEnum::Zero.ordinal()); -assert_eq!(1i16, MyEnum::One.ordinal()); -assert_eq!(2i16, MyEnum::Two.ordinal()); - -assert_eq!(Some(MyEnum::Zero), MyEnum::from_ordinal(0i16)); -assert_eq!(Some(MyEnum::One), MyEnum::from_ordinal(1i16)); -assert_eq!(Some(MyEnum::Two), MyEnum::from_ordinal(2i16)); - -assert_eq!(MyEnum::Zero, unsafe { MyEnum::from_ordinal_unsafe(0i16) }); -assert_eq!(MyEnum::One, unsafe { MyEnum::from_ordinal_unsafe(1i16) }); -assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2i16) }); -``` - -In order to accommodate the value `1000`, the size of `MyEnum` increases. Consequently, the ordinal is represented in `i16` instead of `i8`. - -You can utilize the `#[repr(type)]` attribute to explicitly control the size. For instance, - -```rust -use enum_ordinalize::Ordinalize; - -#[derive(Debug, PartialEq, Eq, Ordinalize)] -#[repr(usize)] -enum MyEnum { - Zero, - One, - Two, - Thousand = 1000, -} - -assert_eq!(4, MyEnum::VARIANT_COUNT); -assert_eq!([MyEnum::Zero, MyEnum::One, MyEnum::Two, MyEnum::Thousand], MyEnum::VARIANTS); -assert_eq!([0usize, 1usize, 2usize, 1000usize], MyEnum::VALUES); - -assert_eq!(0usize, MyEnum::Zero.ordinal()); -assert_eq!(1usize, MyEnum::One.ordinal()); -assert_eq!(2usize, MyEnum::Two.ordinal()); - -assert_eq!(Some(MyEnum::Zero), MyEnum::from_ordinal(0usize)); -assert_eq!(Some(MyEnum::One), MyEnum::from_ordinal(1usize)); -assert_eq!(Some(MyEnum::Two), MyEnum::from_ordinal(2usize)); - -assert_eq!(MyEnum::Zero, unsafe { MyEnum::from_ordinal_unsafe(0usize) }); -assert_eq!(MyEnum::One, unsafe { MyEnum::from_ordinal_unsafe(1usize) }); -assert_eq!(MyEnum::Two, unsafe { MyEnum::from_ordinal_unsafe(2usize) }); -``` - -#### Useful Increment - -The integers represented by variants can be extended in successive increments and set explicitly from any value. - -```rust -use enum_ordinalize::Ordinalize; - -#[derive(Debug, PartialEq, Eq, Ordinalize)] -enum MyEnum { - Two = 2, - Three, - Four, - Eight = 8, - Nine, - NegativeTen = -10, - NegativeNine, -} - -assert_eq!(7, MyEnum::VARIANT_COUNT); -assert_eq!([MyEnum::Two, MyEnum::Three, MyEnum::Four, MyEnum::Eight, MyEnum::Nine, MyEnum::NegativeTen, MyEnum::NegativeNine], MyEnum::VARIANTS); -assert_eq!([2i8, 3i8, 4i8, 8i8, 9i8, -10i8, -9i8], MyEnum::VALUES); - -assert_eq!(4i8, MyEnum::Four.ordinal()); -assert_eq!(9i8, MyEnum::Nine.ordinal()); -assert_eq!(-9i8, MyEnum::NegativeNine.ordinal()); - -assert_eq!(Some(MyEnum::Four), MyEnum::from_ordinal(4i8)); -assert_eq!(Some(MyEnum::Nine), MyEnum::from_ordinal(9i8)); -assert_eq!(Some(MyEnum::NegativeNine), MyEnum::from_ordinal(-9i8)); - -assert_eq!(MyEnum::Four, unsafe { MyEnum::from_ordinal_unsafe(4i8) }); -assert_eq!(MyEnum::Nine, unsafe { MyEnum::from_ordinal_unsafe(9i8) }); -assert_eq!(MyEnum::NegativeNine, unsafe { MyEnum::from_ordinal_unsafe(-9i8) }); -``` - -#### Implement Functionality for an enum on Itself - -For some reason, if you don't want to implement the `Ordinalize` trait for your enum, you can choose to disable the trait implementation and enable the constants/functions one by one. Functions are `const fn`. Names and visibility can also be defined by you. - -```rust -use enum_ordinalize::Ordinalize; - -#[derive(Debug, PartialEq, Eq, Ordinalize)] -#[ordinalize(impl_trait = false)] -#[ordinalize(variant_count(pub const VARIANT_COUNT, doc = "The count of variants."))] -#[ordinalize(variants(pub const VARIANTS, doc = "List of this enum's variants."))] -#[ordinalize(values(pub const VALUES, doc = "List of values for all variants of this enum."))] -#[ordinalize(ordinal(pub const fn ordinal, doc = "Retrieve the integer number of this variant."))] -#[ordinalize(from_ordinal(pub const fn from_ordinal, doc = "Obtain a variant based on an integer number."))] -#[ordinalize(from_ordinal_unsafe( - pub const fn from_ordinal_unsafe, - doc = "Obtain a variant based on an integer number.", - doc = "# Safety", - doc = "You have to ensure that the input integer number can correspond to a variant on your own.", -))] -enum MyEnum { - A, - B, -} - -assert_eq!(2, MyEnum::VARIANT_COUNT); -assert_eq!([MyEnum::A, MyEnum::B], MyEnum::VARIANTS); -assert_eq!([0i8, 1i8], MyEnum::VALUES); - -assert_eq!(0i8, MyEnum::A.ordinal()); -assert_eq!(1i8, MyEnum::B.ordinal()); - -assert_eq!(Some(MyEnum::A), MyEnum::from_ordinal(0i8)); -assert_eq!(Some(MyEnum::B), MyEnum::from_ordinal(1i8)); - -assert_eq!(MyEnum::A, unsafe { MyEnum::from_ordinal_unsafe(0i8) }); -assert_eq!(MyEnum::B, unsafe { MyEnum::from_ordinal_unsafe(1i8) }); -``` - -## Crates.io - -https://crates.io/crates/enum-ordinalize - -## Documentation - -https://docs.rs/enum-ordinalize - -## License - -[MIT](LICENSE)
\ No newline at end of file |
