Skip to content

Use private module to access external crates #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paolobarbolini merged 3 commits into from
Jun 11, 2025
Merged

Use private module to access external crates #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58b7855
fix: reference to crates from macro
dodomorandi Jun 10, 2025
f14106c
fix: manually impl diesel traits
dodomorandi Jun 10, 2025
75b3ecb
style: minor formatting issue in typed_uuid macro
dodomorandi Jun 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions benzina/src/__private/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#[cfg(feature = "typed-uuid")]
mod typed_uuid;

#[cfg(feature = "typed-uuid")]
pub use typed_uuid::*;
6 changes: 6 additions & 0 deletions benzina/src/__private/typed_uuid.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pub use ::diesel;
pub use ::std;
pub use ::uuid;

#[cfg(feature = "serde")]
pub use ::serde;
2 changes: 2 additions & 0 deletions benzina/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ pub use self::int::{U15, U31, U63};
#[cfg(feature = "derive")]
pub use benzina_derive::Enum;

#[doc(hidden)]
pub mod __private;
#[cfg(feature = "postgres")]
pub mod error;
#[cfg(feature = "example-generated")]
Expand Down
243 changes: 190 additions & 53 deletions benzina/src/typed_uuid.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,118 +73,252 @@ macro_rules! typed_uuid {
$(
$(#[$attr])*
#[derive(
::std::fmt::Debug,
::std::clone::Clone,
::std::marker::Copy,
::std::cmp::PartialEq,
::std::cmp::Eq,
::std::cmp::PartialOrd,
::std::cmp::Ord,
::std::hash::Hash,
::diesel::expression::AsExpression,
::diesel::deserialize::FromSqlRow,
$crate::__private::std::fmt::Debug,
$crate::__private::std::clone::Clone,
$crate::__private::std::marker::Copy,
$crate::__private::std::cmp::PartialEq,
$crate::__private::std::cmp::Eq,
$crate::__private::std::cmp::PartialOrd,
$crate::__private::std::cmp::Ord,
$crate::__private::std::hash::Hash,
)]
#[diesel(sql_type = ::diesel::pg::sql_types::Uuid)]
$vis struct $name(::uuid::Uuid);
$vis struct $name($crate::__private::uuid::Uuid);

impl $name {
/// Gets the actual [`Uuid`].
///
/// [`Uuid`]: ::uuid::Uuid
/// [`Uuid`]: $crate::__private::uuid::Uuid
Copy link
Member

@paolobarbolini paolobarbolini Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be pointing at ::uuid::Uuid given that it's just docs?

Copy link
Contributor Author

@dodomorandi dodomorandi Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked this, it works flawlessly -- probably rustdoc is able to check that it should point to the original crate instead of the private module.

This is a screenshot of the doc of a dummy crate that only imports benzina (and it does not declare uuid in the deps)
Screenshot

#[must_use]
pub fn get(&self) -> ::uuid::Uuid {
pub fn get(&self) -> $crate::__private::uuid::Uuid {
self.0
}
}

impl ::diesel::deserialize::FromSql<::diesel::pg::sql_types::Uuid, ::diesel::pg::Pg> for $name {
fn from_sql(value: ::diesel::pg::PgValue<'_>) -> ::diesel::deserialize::Result<Self> {
uuid::Uuid::from_slice(value.as_bytes())
impl $crate::__private::diesel::deserialize::FromSql<$crate::__private::diesel::pg::sql_types::Uuid, $crate::__private::diesel::pg::Pg> for $name {
fn from_sql(value: $crate::__private::diesel::pg::PgValue<'_>) -> $crate::__private::diesel::deserialize::Result<Self> {
$crate::__private::uuid::Uuid::from_slice(value.as_bytes())
.map(Self)
.map_err(Into::into)
}
}

impl ::diesel::serialize::ToSql<::diesel::pg::sql_types::Uuid, ::diesel::pg::Pg> for $name {
fn to_sql<'b>(&'b self, out: &mut ::diesel::serialize::Output<'b, '_, ::diesel::pg::Pg>) -> ::diesel::serialize::Result {
::std::io::Write::write_all(out, self.0.as_bytes())
.map(|_| ::diesel::serialize::IsNull::No)
impl $crate::__private::diesel::serialize::ToSql<$crate::__private::diesel::pg::sql_types::Uuid, $crate::__private::diesel::pg::Pg> for $name {
fn to_sql<'b>(&'b self, out: &mut $crate::__private::diesel::serialize::Output<'b, '_, $crate::__private::diesel::pg::Pg>) -> $crate::__private::diesel::serialize::Result {
$crate::__private::std::io::Write::write_all(out, self.0.as_bytes())
.map(|_| $crate::__private::diesel::serialize::IsNull::No)
.map_err(Into::into)
}
}

impl ::std::cmp::PartialEq<::uuid::Uuid> for $name {
fn eq(&self, other: &::uuid::Uuid) -> bool {
// These are manually implemented because the derive macro uses `diesel` instead of the
// private path.
impl<
'__expr,
> $crate::__private::diesel::expression::AsExpression<$crate::__private::diesel::pg::sql_types::Uuid>
for &'__expr $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::pg::sql_types::Uuid,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::pg::sql_types::Uuid,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}
impl<
'__expr,
> $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<$crate::__private::diesel::pg::sql_types::Uuid>,
> for &'__expr $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}
impl<
'__expr,
'__expr2,
> $crate::__private::diesel::expression::AsExpression<$crate::__private::diesel::pg::sql_types::Uuid>
for &'__expr2 &'__expr $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::pg::sql_types::Uuid,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::pg::sql_types::Uuid,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}
impl<
'__expr,
'__expr2,
> $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<$crate::__private::diesel::pg::sql_types::Uuid>,
> for &'__expr2 &'__expr $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}
impl<
__DB,
> $crate::__private::diesel::serialize::ToSql<
$crate::__private::diesel::sql_types::Nullable<$crate::__private::diesel::pg::sql_types::Uuid>,
__DB,
> for $name
where
__DB: $crate::__private::diesel::backend::Backend,
Self: $crate::__private::diesel::serialize::ToSql<
$crate::__private::diesel::pg::sql_types::Uuid,
__DB,
>,
{
fn to_sql<'__b>(
&'__b self,
out: &mut $crate::__private::diesel::serialize::Output<'__b, '_, __DB>,
) -> $crate::__private::diesel::serialize::Result {
$crate::__private::diesel::serialize::ToSql::<
$crate::__private::diesel::pg::sql_types::Uuid,
__DB,
>::to_sql(self, out)
}
}
impl $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::pg::sql_types::Uuid,
> for $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::pg::sql_types::Uuid,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::pg::sql_types::Uuid,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}
impl $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<$crate::__private::diesel::pg::sql_types::Uuid>,
> for $name {
type Expression = $crate::__private::diesel::internal::derives::as_expression::Bound<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
Self,
>;
fn as_expression(
self,
) -> <Self as $crate::__private::diesel::expression::AsExpression<
$crate::__private::diesel::sql_types::Nullable<
$crate::__private::diesel::pg::sql_types::Uuid,
>,
>>::Expression {
$crate::__private::diesel::internal::derives::as_expression::Bound::new(self)
}
}


impl $crate::__private::std::cmp::PartialEq<$crate::__private::uuid::Uuid> for $name {
fn eq(&self, other: &$crate::__private::uuid::Uuid) -> bool {
self.0 == *other
}
}

impl ::std::cmp::PartialEq<$name> for ::uuid::Uuid {
impl $crate::__private::std::cmp::PartialEq<$name> for $crate::__private::uuid::Uuid {
fn eq(&self, other: &$name) -> bool {
*self == other.0
}
}

impl ::std::cmp::PartialEq<::uuid::NonNilUuid> for $name {
fn eq(&self, other: &::uuid::NonNilUuid) -> bool {
impl $crate::__private::std::cmp::PartialEq<$crate::__private::uuid::NonNilUuid> for $name {
fn eq(&self, other: &$crate::__private::uuid::NonNilUuid) -> bool {
self.0 == *other
}
}

impl ::std::cmp::PartialEq<$name> for ::uuid::NonNilUuid {
impl $crate::__private::std::cmp::PartialEq<$name> for $crate::__private::uuid::NonNilUuid {
fn eq(&self, other: &$name) -> bool {
*self == other.0
}
}

impl ::std::convert::AsRef<[u8]> for $name {
impl $crate::__private::std::convert::AsRef<[u8]> for $name {
fn as_ref(&self) -> &[u8] {
::std::convert::AsRef::as_ref(&self.0)
$crate::__private::std::convert::AsRef::as_ref(&self.0)
}
}

impl ::std::convert::AsRef<::uuid::Uuid> for $name {
fn as_ref(&self) -> &::uuid::Uuid {
impl $crate::__private::std::convert::AsRef<$crate::__private::uuid::Uuid> for $name {
fn as_ref(&self) -> &$crate::__private::uuid::Uuid {
&self.0
}
}

impl ::std::convert::From<$name> for ::uuid::Uuid {
impl $crate::__private::std::convert::From<$name> for $crate::__private::uuid::Uuid {
fn from(value: $name) -> Self {
value.0
}
}

$crate::__typed_uuid__forward_from!(
$name:
::uuid::fmt::Braced,
::uuid::fmt::Hyphenated,
::uuid::fmt::Simple,
::uuid::fmt::Urn,
::std::string::String,
::std::vec::Vec<u8>,
$crate::__private::uuid::fmt::Braced,
$crate::__private::uuid::fmt::Hyphenated,
$crate::__private::uuid::fmt::Simple,
$crate::__private::uuid::fmt::Urn,
$crate::__private::std::string::String,
$crate::__private::std::vec::Vec<u8>,
);

impl ::std::fmt::Display for $name {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
::std::fmt::Display::fmt(&self.0, f)
impl $crate::__private::std::fmt::Display for $name {
fn fmt(&self, f: &mut $crate::__private::std::fmt::Formatter<'_>) -> $crate::__private::std::fmt::Result {
$crate::__private::std::fmt::Display::fmt(&self.0, f)
}
}

impl ::std::fmt::LowerHex for $name {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
::std::fmt::LowerHex::fmt(&self.0, f)
impl $crate::__private::std::fmt::LowerHex for $name {
fn fmt(&self, f: &mut $crate::__private::std::fmt::Formatter<'_>) -> $crate::__private::std::fmt::Result {
$crate::__private::std::fmt::LowerHex::fmt(&self.0, f)
}
}

impl ::std::fmt::UpperHex for $name {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
::std::fmt::UpperHex::fmt(&self.0, f)
impl $crate::__private::std::fmt::UpperHex for $name {
fn fmt(&self, f: &mut $crate::__private::std::fmt::Formatter<'_>) -> $crate::__private::std::fmt::Result {
$crate::__private::std::fmt::UpperHex::fmt(&self.0, f)
}
}

$crate::__typed_uuid__impl_serde!($name);
)+
)+
};
}

Expand All @@ -193,7 +327,7 @@ macro_rules! typed_uuid {
macro_rules! __typed_uuid__forward_from {
($name:ident: $($ty:path),+ $(,)?) => {
$(
impl ::std::convert::From<$name> for $ty {
impl $crate::__private::std::convert::From<$name> for $ty {
fn from(value: $name) -> Self {
Self::from(value.0)
}
Expand All @@ -207,12 +341,15 @@ macro_rules! __typed_uuid__forward_from {
#[cfg(feature = "serde")]
macro_rules! __typed_uuid__impl_serde {
($name:ident) => {
impl ::serde::Serialize for $name {
fn serialize<S>(&self, serializer: S) -> ::std::result::Result<S::Ok, S::Error>
impl $crate::__private::serde::Serialize for $name {
fn serialize<S>(
&self,
serializer: S,
) -> $crate::__private::std::result::Result<S::Ok, S::Error>
where
S: ::serde::Serializer,
S: $crate::__private::serde::Serializer,
{
::serde::Serialize::serialize(&self.0, serializer)
$crate::__private::serde::Serialize::serialize(&self.0, serializer)
}
}
};
Expand Down