Reorganize crate exports (#53)

* Slight refactoring in cgp-field

* Move cgp_error::impls to new cgp_error_extra crate

* Add feature flags for alloc in cgp-error-extra

* Reorganize exports and make them explicit

* Add changelog

* Reformat exports

Author: soareschen

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## v0.3.0 (pre-release)
 
+- Reorganize crate exports - [#53](https://github.com/contextgeneric/cgp/pull/53)
+    - Move generic error providers to the `cgp-error-extra` crate.
+    - Add an `alloc` feature to `cgp-error-extra` to enable use of `alloc` in providers.
+    - Make private the sub-modules inside CGP crates.
+    - Explicitly export module items instead of using `*`.
+
 - Move `cgp-inner` to `cgp-extra` - [#51](https://github.com/contextgeneric/cgp/pull/51)
     - Remove re-export of `cgp-inner` from `cgp-core`.
     - Re-export `cgp-inner` and `cgp-runtime` from `cgp-extra`.

Cargo.lock

@@ -17,6 +17,7 @@ members = [
     "crates/cgp-field-macro",
     "crates/cgp-field-macro-lib",
     "crates/cgp-error",
+    "crates/cgp-error-extra",
     "crates/cgp-error-anyhow",
     "crates/cgp-error-eyre",
     "crates/cgp-error-std",
@@ -48,6 +49,7 @@ cgp-field                   = { path = "./crates/cgp-field" }
 cgp-field-macro             = { path = "./crates/cgp-field-macro" }
 cgp-field-macro-lib         = { path = "./crates/cgp-field-macro-lib" }
 cgp-error                   = { path = "./crates/cgp-error" }
+cgp-error-extra             = { path = "./crates/cgp-error-extra" }
 cgp-run                     = { path = "./crates/cgp-run" }
 cgp-runtime                 = { path = "./crates/cgp-runtime" }
 cgp-inner                   = { path = "./crates/cgp-inner" }

Cargo.toml

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use proc_macro2::{Group, TokenStream, TokenTree};
 use syn::parse::{Parse, ParseStream};
 use syn::token::{Async, Await, Dot, Fn};

crates/cgp-async-macro/src/strip_async.rs

@@ -2,10 +2,8 @@
 
 pub mod traits;
 
-pub use traits::{Async, MaybeSend, MaybeStatic, MaybeSync};
-
 #[cfg(feature = "async")]
 pub use cgp_async_macro::native_async as async_trait;
-
 #[cfg(not(feature = "async"))]
 pub use cgp_sync::async_trait;
+pub use traits::{Async, MaybeSend, MaybeStatic, MaybeSync};

crates/cgp-async/src/lib.rs

@@ -1,6 +1,7 @@
 use alloc::boxed::Box;
 use alloc::vec;
 use alloc::vec::Vec;
+
 use syn::{parse_quote, Generics, ImplItem, ImplItemType, ItemImpl, Path, Type};
 
 use crate::delegate_components::ast::{ComponentAst, DelegateEntriesAst};

crates/cgp-component-macro-lib/src/delegate_components/impl_delegate.rs

@@ -1,4 +1,5 @@
 use alloc::format;
+
 use proc_macro2::Span;
 use quote::ToTokens;
 use syn::parse::{Parse, ParseStream};

crates/cgp-component-macro-lib/src/derive_component/component_spec.rs

@@ -1,5 +1,6 @@
 use alloc::boxed::Box;
 use alloc::vec::Vec;
+
 use syn::punctuated::Punctuated;
 use syn::token::{Brace, Comma, For, Impl, Plus};
 use syn::{

crates/cgp-component-macro-lib/src/derive_component/consumer_impl.rs

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use proc_macro2::TokenStream;
 use quote::quote;
 use syn::{parse_quote, ImplItemFn, Signature, TypePath, Visibility};

crates/cgp-component-macro-lib/src/derive_component/delegate_fn.rs

@@ -1,5 +1,6 @@
 use alloc::boxed::Box;
 use alloc::vec::Vec;
+
 use proc_macro2::Span;
 use syn::punctuated::Punctuated;
 use syn::token::{Brace, Comma, For, Impl, Plus};

crates/cgp-component-macro-lib/src/derive_component/provider_impl.rs

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use syn::punctuated::Punctuated;
 use syn::{parse_quote, Ident, ItemTrait, TraitItem};
 

crates/cgp-component-macro-lib/src/derive_component/provider_trait.rs

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use itertools::Itertools;
 use proc_macro2::{Group, Ident, TokenStream, TokenTree};
 use quote::{format_ident, ToTokens};

crates/cgp-component-macro-lib/src/derive_component/replace_self_type.rs

@@ -1,4 +1,5 @@
 use alloc::string::{String, ToString};
+
 use proc_macro2::Span;
 use syn::Ident;
 

crates/cgp-component-macro-lib/src/derive_component/snake_case.rs

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use proc_macro2::{Group, TokenStream, TokenTree};
 use quote::{quote, ToTokens};
 use syn::__private::parse_brackets;

crates/cgp-component-macro-lib/src/for_each_replace.rs

@@ -1,5 +1,6 @@
 use alloc::format;
 use alloc::string::ToString;
+
 use proc_macro2::{Span, TokenStream};
 use quote::ToTokens;
 use syn::{parse_quote, Ident, ItemTrait};

crates/cgp-component-macro-lib/src/preset/define_preset.rs

@@ -1,4 +1,5 @@
 use alloc::vec::Vec;
+
 use syn::{parse_quote, Generics, Ident, ItemImpl, Type};
 
 use crate::delegate_components::ast::{ComponentAst, DelegateEntriesAst};

crates/cgp-component-macro-lib/src/preset/impl_is_preset.rs

@@ -1,4 +1,5 @@
 use alloc::string::{String, ToString};
+
 use prettyplease::unparse;
 use proc_macro2::TokenStream;
 use syn::parse_file;

crates/cgp-component-macro-lib/src/tests/helper/format.rs

@@ -4,8 +4,8 @@
    This crate defines the core CGP traits, [`DelegateComponent`] and [`HasComponents`].
 */
 
-pub mod traits;
-pub mod types;
+mod traits;
+mod types;
 
 pub use traits::{DelegateComponent, HasComponents};
 pub use types::{UseContext, UseDelegate, WithContext, WithProvider};

crates/cgp-component/src/lib.rs

@@ -1,5 +1,5 @@
-pub mod delegate_component;
-pub mod has_components;
+mod delegate_component;
+mod has_components;
 
 pub use delegate_component::DelegateComponent;
 pub use has_components::HasComponents;

crates/cgp-component/src/traits/mod.rs

@@ -1,6 +1,6 @@
-pub mod use_context;
-pub mod use_delegate;
-pub mod with_provider;
+mod use_context;
+mod use_delegate;
+mod with_provider;
 
 pub use use_context::{UseContext, WithContext};
 pub use use_delegate::UseDelegate;

crates/cgp-component/src/types/mod.rs

@@ -3,6 +3,6 @@ pub use cgp_component::{DelegateComponent, HasComponents};
 pub use cgp_component_macro::{
     cgp_component, cgp_preset, delegate_components, for_each_replace, replace_with,
 };
-pub use cgp_error::traits::{CanRaiseError, CanWrapError, HasErrorType};
+pub use cgp_error::{CanRaiseError, CanWrapError, HasErrorType};
 pub use cgp_field::{Char, Cons, Either, HasField, HasFieldMut, Nil, Void};
 pub use cgp_field_macro::{product, symbol, HasField, Product, Sum};

crates/cgp-core/src/prelude.rs

@@ -1,9 +1,9 @@
-pub mod debug_error;
-pub mod display_error;
-pub mod raise_anyhow_error;
-pub mod use_anyhow_error;
+mod debug_error;
+mod display_error;
+mod raise_anyhow_error;
+mod use_anyhow_error;
 
-pub use debug_error::*;
-pub use display_error::*;
-pub use raise_anyhow_error::*;
-pub use use_anyhow_error::*;
+pub use debug_error::DebugAnyhowError;
+pub use display_error::DisplayAnyhowError;
+pub use raise_anyhow_error::RaiseAnyhowError;
+pub use use_anyhow_error::UseAnyhowError;

crates/cgp-error-anyhow/src/impls/mod.rs

@@ -1,5 +1,5 @@
 #![no_std]
 
-pub mod impls;
+mod impls;
 
-pub use impls::*;
+pub use impls::{DebugAnyhowError, DisplayAnyhowError, RaiseAnyhowError, UseAnyhowError};

crates/cgp-error-anyhow/src/lib.rs

@@ -0,0 +1,19 @@
+[package]
+name         = "cgp-error-extra"
+version      = "0.2.0"
+edition      = { workspace = true }
+license      = { workspace = true }
+repository   = { workspace = true }
+authors      = { workspace = true }
+rust-version = { workspace = true }
+keywords     = { workspace = true }
+description  = """
+    Context-generic programming error components
+"""
+
+[features]
+default = [ "alloc" ]
+alloc = []
+
+[dependencies]
+cgp-error           = { version = "0.2.0" }

crates/cgp-error-extra/Cargo.toml

@@ -2,7 +2,7 @@ use alloc::format;
 use alloc::string::String;
 use core::fmt::Debug;
 
-use crate::traits::{CanRaiseError, ErrorRaiser};
+use cgp_error::{CanRaiseError, ErrorRaiser};
 
 pub struct DebugError;
 

crates/cgp-error/src/impls/debug_error.rs crates/cgp-error-extra/src/impls/alloc/debug_error.rs

@@ -2,7 +2,7 @@ use alloc::format;
 use alloc::string::String;
 use core::fmt::Display;
 
-use crate::traits::{CanRaiseError, ErrorRaiser};
+use cgp_error::{CanRaiseError, ErrorRaiser};
 
 pub struct DisplayError;
 

crates/cgp-error/src/impls/display_error.rs crates/cgp-error-extra/src/impls/alloc/display_error.rs

@@ -0,0 +1,5 @@
+mod debug_error;
+mod display_error;
+
+pub use debug_error::DebugError;
+pub use display_error::DisplayError;

crates/cgp-error-extra/src/impls/alloc/mod.rs

@@ -1,4 +1,4 @@
-use crate::traits::{ErrorWrapper, HasErrorType};
+use cgp_error::{ErrorWrapper, HasErrorType};
 
 pub struct DiscardDetail;
 

crates/cgp-error/src/impls/discard_detail.rs crates/cgp-error-extra/src/impls/discard_detail.rs

@@ -1,6 +1,6 @@
 use core::convert::Infallible;
 
-use crate::traits::{ErrorRaiser, HasErrorType};
+use cgp_error::{ErrorRaiser, HasErrorType};
 
 pub struct RaiseInfallible;
 

crates/cgp-error/src/impls/infallible.rs crates/cgp-error-extra/src/impls/infallible.rs

@@ -0,0 +1,17 @@
+#[cfg(feature = "alloc")]
+mod alloc;
+
+mod discard_detail;
+mod infallible;
+mod panic_error;
+mod raise_from;
+mod return_error;
+
+#[cfg(feature = "alloc")]
+pub use alloc::{DebugError, DisplayError};
+
+pub use discard_detail::DiscardDetail;
+pub use infallible::RaiseInfallible;
+pub use panic_error::PanicOnError;
+pub use raise_from::RaiseFrom;
+pub use return_error::ReturnError;

crates/cgp-error-extra/src/impls/mod.rs

@@ -1,6 +1,6 @@
 use core::fmt::Debug;
 
-use crate::traits::{ErrorRaiser, HasErrorType};
+use cgp_error::{ErrorRaiser, HasErrorType};
 
 pub struct PanicOnError;
 

crates/cgp-error/src/impls/panic_error.rs crates/cgp-error-extra/src/impls/panic_error.rs

@@ -1,4 +1,4 @@
-use crate::traits::{ErrorRaiser, HasErrorType};
+use cgp_error::{ErrorRaiser, HasErrorType};
 
 pub struct RaiseFrom;
 

crates/cgp-error/src/impls/raise_from.rs crates/cgp-error-extra/src/impls/raise_from.rs

@@ -1,4 +1,4 @@
-use crate::traits::{ErrorRaiser, HasErrorType};
+use cgp_error::{ErrorRaiser, HasErrorType};
 
 pub struct ReturnError;
 

crates/cgp-error/src/impls/return_error.rs crates/cgp-error-extra/src/impls/return_error.rs

@@ -0,0 +1,10 @@
+#![no_std]
+
+#[cfg(feature = "alloc")]
+extern crate alloc;
+
+mod impls;
+
+#[cfg(feature = "alloc")]
+pub use impls::{DebugError, DisplayError};
+pub use impls::{DiscardDetail, PanicOnError, RaiseFrom, RaiseInfallible, ReturnError};

crates/cgp-error-extra/src/lib.rs

@@ -1,9 +1,9 @@
-pub mod debug_error;
-pub mod display_error;
-pub mod raise_eyre_error;
-pub mod use_eyre_error;
+mod debug_error;
+mod display_error;
+mod raise_eyre_error;
+mod use_eyre_error;
 
-pub use debug_error::*;
-pub use display_error::*;
-pub use raise_eyre_error::*;
-pub use use_eyre_error::*;
+pub use debug_error::DebugEyreError;
+pub use display_error::DisplayEyreError;
+pub use raise_eyre_error::RaiseEyreError;
+pub use use_eyre_error::UseEyreError;

crates/cgp-error-eyre/src/impls/mod.rs

@@ -1,5 +1,5 @@
 #![no_std]
 
-pub mod impls;
+mod impls;
 
-pub use impls::*;
+pub use impls::{DebugEyreError, DisplayEyreError, RaiseEyreError, UseEyreError};

crates/cgp-error-eyre/src/lib.rs

@@ -1,7 +1,7 @@
-use core::fmt::Debug;
-
 use alloc::boxed::Box;
 use alloc::format;
+use core::fmt::Debug;
+
 use cgp_core::error::{ErrorRaiser, HasErrorType};
 
 use crate::types::{Error, StringError};

crates/cgp-error-std/src/impls/debug_error.rs

@@ -1,7 +1,7 @@
-use core::fmt::Display;
-
 use alloc::boxed::Box;
 use alloc::format;
+use core::fmt::Display;
+
 use cgp_core::error::{ErrorRaiser, HasErrorType};
 
 use crate::types::{Error, StringError};

crates/cgp-error-std/src/impls/display_error.rs

@@ -1,9 +1,9 @@
-pub mod debug_error;
-pub mod display_error;
-pub mod raise_boxed;
-pub mod use_boxed;
+mod debug_error;
+mod display_error;
+mod raise_boxed;
+mod use_boxed;
 
-pub use debug_error::*;
-pub use display_error::*;
-pub use raise_boxed::*;
-pub use use_boxed::*;
+pub use debug_error::DebugBoxedStdError;
+pub use display_error::DisplayBoxedStdError;
+pub use raise_boxed::RaiseBoxedStdError;
+pub use use_boxed::UseBoxedStdError;

crates/cgp-error-std/src/impls/mod.rs

@@ -2,8 +2,8 @@
 
 extern crate alloc;
 
-pub mod impls;
-pub mod types;
+mod impls;
+mod types;
 
-pub use impls::*;
-pub use types::*;
+pub use impls::{DebugBoxedStdError, DisplayBoxedStdError, RaiseBoxedStdError, UseBoxedStdError};
+pub use types::{Error, StringError};