trait Transform

.github/workflows/rust-publish.yml

@@ -21,10 +21,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v6
-    - uses: rust-lang/crates-io-auth-action@bbd81622f20ce9e2dd9622e3218b975523e45bbe #v1.0.4
-      id: auth
+    # - uses: rust-lang/crates-io-auth-action@bbd81622f20ce9e2dd9622e3218b975523e45bbe #v1.0.4
+    #   id: auth
     - name: Publish
       env:
-        CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
+        CARGO_REGISTRY_TOKEN: ${{ secrets.CRATES_IO_TOKEN }}
+        # CARGO_REGISTRY_TOKEN: ${{ steps.auth.outputs.token }}
       run:
         cargo publish

.github/workflows/rust.yml

@@ -63,6 +63,13 @@ jobs:
     if: needs.skip_check.outputs.should_skip != 'true'
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate: ["try_v2", "try_v2_derive"]
+
+    defaults:
+      run:
+        working-directory: crates/${{ matrix.crate }}
 
     env:
       RUSTC_BOOTSTRAP: 1

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog try_v2
 
+## [v0.5.0]
+
+### New features
+
+- Add `trait Transform` (Forces move of derive macros to own crate & re-export)
+
+### Breaking changes
+
+- Removed derive `Try_Methods` in favour of trait-based implementation
+
 ## [v0.4.2]
 
 ### Bugfixes

Cargo.toml

@@ -1,36 +1,7 @@
-[package]
-name = "try_v2"
-version = "0.4.2"
-edition = "2024"
-readme = "README.md"
-description = "Provides a derive macro for `Try` ([try_trait_v2](https://rust-lang.github.io/rfcs/3058-try-trait-v2.html))"
-authors = ["Mike Foster <https://github.com/MusicalNinjaDad>"]
-keywords = ["derive", "Try", "try_trait_v2"]
-homepage = "https://github.com/MusicalNinjaDad/try_v2"
-repository = "https://github.com/MusicalNinjaDad/try_v2"
-categories = ["development-tools"]
-license = "MIT"
-rust-version = "1.85.1"
-exclude = [".github", ".devcontainer"]
-
-[lib]
-proc-macro = true
-
-[dependencies]
-syn = {version = "2.0.117", features = ["full","extra-traits"]}
-proc-macro2 = "1.0.106"
-proc_macro2_diagnostic = "0.3.0"
-quote = "1.0.45"
-
-[dev-dependencies]
-log = "0.4.29"
-trybuild = "1.0.116"
-
-[build-dependencies]
-autocfg = "1.5.1"
-
 [workspace]
-members = ["tests/compilation"]
+edition = "2024"
+resolver = "3"
+members = ["crates/*"]
 
 [workspace.dependencies]
-try_v2 = { path = "."}
+try_v2_derive = { path = "crates/try_v2_derive", version = "0.5.0" }

README.md

@@ -1,10 +1,13 @@
 # Try_v2
 
- Provides a derive macro for `Try` & optionally `Try_ConvertResult` for interconversion with
- `std::result::Result` and `Try_Iterator` for iterating over `IntoIterator` and collecting from
- `FromIterator` analogous to how `Result` & `Option` do this.
- See ([try_trait_v2](https://rust-lang.github.io/rfcs/3058-try-trait-v2.html)) for more details
- of the underlying trait.
+ Provides:
+
+- a derive macro for `Try`
+- traits with standard methods to make TryTypes usable (e.g. `trait Transform` provides `.map()`)
+- derive `Try_ConvertResult` for interconversion with `std::result::Result`
+- derive `Try_Iterator` for iterating over `IntoIterator` and collecting from `FromIterator` analogous to how `Result` & `Option` do this.
+
+See ([try_trait_v2](https://rust-lang.github.io/rfcs/3058-try-trait-v2.html)) for more details of the underlying trait.
 
 ## Requires
 

crates/try_v2/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "try_v2"
+version = "0.5.0"
+edition = "2024"
+readme = "README.md"
+description = "Provides a derive macro & helper traits for `Try`"
+authors = ["Mike Foster <https://github.com/MusicalNinjaDad>"]
+keywords = ["derive", "Try", "try_trait_v2"]
+homepage = "https://github.com/MusicalNinjaDad/try_v2"
+repository = "https://github.com/MusicalNinjaDad/try_v2"
+categories = ["development-tools"]
+license = "MIT"
+rust-version = "1.85.1"
+exclude = [".github", ".devcontainer"]
+
+[lib]
+
+[dependencies]
+try_v2_derive = { workspace = true }
+
+[dev-dependencies]
+
+[build-dependencies]

crates/try_v2/src/lib.rs

@@ -0,0 +1,123 @@
+#![feature(try_trait_v2)]
+#![feature(try_trait_v2_residual)]
+#![cfg_attr(test, feature(option_zip))]
+
+//! Provides a derive macro for [Try] & optionally [Try_ConvertResult] for interconversion with
+//! `std::result::Result` and [Try_Iterator] for iterating over `IntoIterator` and collecting from
+//! `FromIterator` analog to how `Result` & `Option` do this.
+//! See ([try_trait_v2](https://rust-lang.github.io/rfcs/3058-try-trait-v2.html)) for more details
+//! of the underlying trait.
+//!
+//! ## Requires
+//!
+//!   - nightly
+//!   - `#![feature(never_type)]`
+//!   - `#![feature(try_trait_v2)]`
+//!   - `#![feature(try_trait_v2_residual)]`
+//!   - optionally: `#![feature(iterator_try_collect)]` (if using Try_Iterator)
+//!
+//! ## Limitations on the annotated type
+//!
+//!   - must be an `enum`
+//!   - must have _at least one_ generic type
+//!   - the _first_ generic type must be the `Output` type (produced when not short-circuiting)
+//!   - the output variant (does not short-circuit) must be the _first_ variant and store the output
+//!     type as the _only unnamed_ field
+//!   - no other variant can store the Output type (TODO #72 add a nice error message)
+//!
+//! See the individual documentation for [Try], [Try_ConvertResult] and [Try_Iterator] for specifics
+//! on the generated code.
+//!
+//! ## Example Usage
+//!
+//! ```rust
+//! #![feature(never_type)]
+//! #![feature(try_trait_v2)]
+//! #![feature(try_trait_v2_residual)]
+//! use try_v2::{Try, Try_ConvertResult};
+//!
+//! #[derive(Try, Try_ConvertResult)]
+//! enum TestResult<T> {
+//!     Ok(T),
+//!     TestsFailed,
+//!     OtherError(String)
+//! }
+//!
+//! // Basic short-circuiting thanks to `#[derive(Try)]`
+//! fn run_tests() -> TestResult<()> {
+//!     TestResult::OtherError("oops!".to_string())?; // <- Function short-circuits here ...
+//!     TestResult::TestsFailed?;
+//!     TestResult::Ok(())
+//! }
+//!
+//! assert!(matches!(run_tests(), TestResult::OtherError(msg) if msg == "oops!"));
+//!
+//!
+//! // Conversion from std::result::Result thanks to `#[derive(Try_ConvertResult)]`
+//! struct TestFailure {}
+//!
+//! impl<T> From<TestFailure> for TestResult<T> {
+//!     fn from(err: TestFailure) -> Self {
+//!         TestResult::TestsFailed
+//!     }
+//! }
+//!
+//! fn run_more_tests() -> TestResult<()> {
+//!     std::result::Result::Err(TestFailure{})?; // <- Function short-circuits here & converts to a TestResult...
+//!     TestResult::Ok(())
+//! }
+//!
+//! assert!(matches!(run_more_tests(), TestResult::TestsFailed));
+//! ```
+//!
+//! ## Stability & MSRV
+//!
+//! Given that this crate exposes an experimental API from std it makes use of experimental
+//! features which require a nightly toolchain.
+//!
+//! In order to use this crate you must enable the features which it exposes:
+//!
+//! > 🔬 **Required Experimental Features**
+//! >
+//! >  - [`#![feature(never_type)]`](https://github.com/rust-lang/rust/issues/35121)
+//! >  - [`#![feature(try_trait_v2)]`](https://github.com/rust-lang/rust/issues/84277)
+//! >  - [`#![feature(try_trait_v2_residual)]`](https://github.com/rust-lang/rust/issues/91285)
+//! >  - optionally: [`#![feature(iterator_try_collect)]`](https://github.com/rust-lang/rust/issues/94047) (if using [Try_Iterator])
+//!
+//! This crate makes use of the following experimental features in addition to those which it
+//! directly supports:
+//!
+//! > 🔬 **Additional Experimental Features**
+//! >
+//! > - [`#![feature(if_let_guard)]`](https://github.com/rust-lang/rust/issues/51114) (stable since 1.95.0)
+//! > - [`#![feature(let_chains)]`](https://github.com/rust-lang/rust/issues/139951) (stable since 1.88.0)
+//! >
+//! > This list includes any unstable features used by direct & transitive dependencies (currently, none).
+//! >
+//! > You do not need to enable these in your own code, the list is for information only.
+//!
+//! ### Stability guarantees
+//!
+//! We run automated tests **every month** to ensure no fundamental changes affect this crate and
+//! test every PR against the current nightly, as well as the current equivalent beta & stable.
+//! If you find an issue before we do, please
+//! [raise an issue on github](https://github.com/MusicalNinjaDad/try_v2/issues).
+//!
+//! ### MSRV
+//!
+//! For those of you working with a pinned nightly (etc.) this crate supports every version of
+//! edition 2024 (rust 1.85.1 onwards, released as stable on 2025-03-18). We use
+//! [autocfg](https://crates.io/crates/autocfg/) to seamlessly handle features which have been
+//! stabilised since then.
+//!
+//! ## Currently untested (may work, may not ...):
+//!
+//!   - `where` clauses
+//!   - storing `Fn`s in variants
+
+#[doc(inline)]
+pub use try_v2_derive::*;
+
+mod transform;
+#[doc(inline)]
+pub use transform::Transform;