{"id":15994668,"url":"https://github.com/taiki-e/derive_utils","last_synced_at":"2025-04-04T22:05:33.098Z","repository":{"id":45079664,"uuid":"161876876","full_name":"taiki-e/derive_utils","owner":"taiki-e","description":"A procedural macro helper for easily writing custom derives for enums.","archived":false,"fork":false,"pushed_at":"2024-10-20T18:33:55.000Z","size":378,"stargazers_count":31,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-20T22:59:33.636Z","etag":null,"topics":["proc-macro","rust"],"latest_commit_sha":null,"homepage":"https://docs.rs/derive_utils","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taiki-e.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"taiki-e"}},"created_at":"2018-12-15T06:25:51.000Z","updated_at":"2024-10-20T18:33:59.000Z","dependencies_parsed_at":"2023-10-10T17:27:08.152Z","dependency_job_id":"97646cd9-826d-4ecf-b944-299035cfb37a","html_url":"https://github.com/taiki-e/derive_utils","commit_stats":{"total_commits":384,"total_committers":2,"mean_commits":192.0,"dds":"0.0026041666666666297","last_synced_commit":"20d27438568c282748ec7c9c07e65e6cedcff974"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiki-e%2Fderive_utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiki-e%2Fderive_utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiki-e%2Fderive_utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiki-e%2Fderive_utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taiki-e","download_url":"https://codeload.github.com/taiki-e/derive_utils/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256110,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["proc-macro","rust"],"created_at":"2024-10-08T07:09:44.676Z","updated_at":"2025-04-04T22:05:33.073Z","avatar_url":"https://github.com/taiki-e.png","language":"Shell","readme":"# derive_utils\n\n[![crates.io](https://img.shields.io/crates/v/derive_utils?style=flat-square\u0026logo=rust)](https://crates.io/crates/derive_utils)\n[![docs.rs](https://img.shields.io/badge/docs.rs-derive__utils-blue?style=flat-square\u0026logo=docs.rs)](https://docs.rs/derive_utils)\n[![license](https://img.shields.io/badge/license-Apache--2.0_OR_MIT-blue?style=flat-square)](#license)\n[![msrv](https://img.shields.io/badge/msrv-1.56-blue?style=flat-square\u0026logo=rust)](https://www.rust-lang.org)\n[![github actions](https://img.shields.io/github/actions/workflow/status/taiki-e/derive_utils/ci.yml?branch=main\u0026style=flat-square\u0026logo=github)](https://github.com/taiki-e/derive_utils/actions)\n\nA procedural macro helper for easily writing [derives macros][proc-macro-derive] for enums.\n\n## Usage\n\nAdd this to your `Cargo.toml`:\n\n```toml\n[dependencies]\nderive_utils = \"0.15\"\n```\n\n## Examples\n\n[`quick_derive!`] macro make easy to write [`proc_macro_derive`][proc-macro-derive]\nlike deriving trait to enum so long as all variants are implemented that trait.\n\n```rust\nuse derive_utils::quick_derive;\nuse proc_macro::TokenStream;\n\n#[proc_macro_derive(Iterator)]\npub fn derive_iterator(input: TokenStream) -\u003e TokenStream {\n    quick_derive! {\n        input,\n        // trait path\n        std::iter::Iterator,\n        // trait definition\n        trait Iterator {\n            type Item;\n            fn next(\u0026mut self) -\u003e Option\u003cSelf::Item\u003e;\n            fn size_hint(\u0026self) -\u003e (usize, Option\u003cusize\u003e);\n        }\n    }\n}\n\n#[proc_macro_derive(ExactSizeIterator)]\npub fn derive_exact_size_iterator(input: TokenStream) -\u003e TokenStream {\n    quick_derive! {\n        input,\n        // trait path\n        std::iter::ExactSizeIterator,\n        // super trait's associated types\n        \u003cItem\u003e,\n        // trait definition\n        trait ExactSizeIterator: Iterator {\n            fn len(\u0026self) -\u003e usize;\n        }\n    }\n}\n```\n\n### Generated code\n\nWhen deriving for enum like the following:\n\n```rust\n#[derive(Iterator, ExactSizeIterator, Future)]\nenum Enum\u003cA, B\u003e {\n    A(A),\n    B(B),\n}\n```\n\nCode like this will be generated:\n\n```rust\nenum Enum\u003cA, B\u003e {\n    A(A),\n    B(B),\n}\n\n#[automatically_derived]\nimpl\u003cA, B\u003e std::iter::Iterator for Enum\u003cA, B\u003e\nwhere\n    A: std::iter::Iterator,\n    B: std::iter::Iterator\u003cItem = \u003cA as std::iter::Iterator\u003e::Item\u003e,\n{\n    type Item = \u003cA as std::iter::Iterator\u003e::Item;\n    fn next(\u0026mut self) -\u003e Option\u003cSelf::Item\u003e {\n        match self {\n            Enum::A(x) =\u003e x.next(),\n            Enum::B(x) =\u003e x.next(),\n        }\n    }\n    fn size_hint(\u0026self) -\u003e (usize, Option\u003cusize\u003e) {\n        match self {\n            Enum::A(x) =\u003e x.size_hint(),\n            Enum::B(x) =\u003e x.size_hint(),\n        }\n    }\n}\n\n#[automatically_derived]\nimpl\u003cA, B\u003e std::iter::ExactSizeIterator for Enum\u003cA, B\u003e\nwhere\n    A: std::iter::ExactSizeIterator,\n    B: std::iter::ExactSizeIterator\u003cItem = \u003cA as Iterator\u003e::Item\u003e,\n{\n    fn len(\u0026self) -\u003e usize {\n        match self {\n            Enum::A(x) =\u003e x.len(),\n            Enum::B(x) =\u003e x.len(),\n        }\n    }\n}\n```\n\n## Related Projects\n\n- [auto_enums]: A library for to allow multiple return types by automatically generated enum.\n- [io-enum]: \\#\\[derive(Read, Write, Seek, BufRead)\\] for enums.\n- [iter-enum]: \\#\\[derive(Iterator, DoubleEndedIterator, ExactSizeIterator, FusedIterator, Extend)\\] for enums.\n\n[auto_enums]: https://github.com/taiki-e/auto_enums\n[io-enum]: https://github.com/taiki-e/io-enum\n[iter-enum]: https://github.com/taiki-e/iter-enum\n[proc-macro-derive]: https://doc.rust-lang.org/reference/procedural-macros.html#derive-macros\n\n[`quick_derive!`]: https://docs.rs/derive_utils/latest/derive_utils/macro.quick_derive.html\n\n## License\n\nLicensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or\n[MIT license](LICENSE-MIT) at your option.\n\nUnless you explicitly state otherwise, any contribution intentionally submitted\nfor inclusion in the work by you, as defined in the Apache-2.0 license, shall\nbe dual licensed as above, without any additional terms or conditions.\n","funding_links":["https://github.com/sponsors/taiki-e"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaiki-e%2Fderive_utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaiki-e%2Fderive_utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaiki-e%2Fderive_utils/lists"}