Skip to content

Commit

Permalink
Feature: Remove need of use get_size::GetSize for #[derive(get_size::…
Browse files Browse the repository at this point in the history 
…GetSize)] (#3)

This commit enhances the user experience by eliminating the need for
explicit import statements when using `#[derive(get_size::GetSize)]`.
Previously, the use of this derive required an accompanying
`use get_size::GetSize;` statement, without which the compiler would
raise a not-found trait error.

- **Automatic Trait Reference:**
  - The derived code now references the `GetSize` trait using the full
    path `::get_size::GetSize`. This change ensures that the trait is
    recognized by the compiler without requiring an explicit import
    statement by the user.

- **Use Case for Protobuf:**
  - This update is particularly beneficial in scenarios like adding
    derives to protobuf-generated code, where manually importing traits
    can be challenging or impossible.

This commit simplifies the development process by streamlining the use
of the `GetSize` derive and improving compatibility with generated code
bases.

Co-authored-by: 张炎泼 <drdr.xp@gmail.com>
  • Loading branch information
@bircni @drmingdrmer
bircni and drmingdrmer authored Sep 14, 2024
1 parent 50485a2 commit 067e8e3
Showing 1 changed file with 15 additions and 13 deletions.
28 changes: 15 additions & 13 deletions get-size-derive2/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,9 @@ fn add_trait_bounds(mut generics: syn::Generics, ignored: &Vec<syn::PathSegment>
continue;
}

type_param.bounds.push(syn::parse_quote!(GetSize));
type_param
.bounds
.push(syn::parse_quote!(::get_size2::GetSize));
}
}
generics
Expand Down Expand Up @@ -108,7 +110,7 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {
if data_enum.variants.is_empty() {
// Empty enums are easy to implement.
let gen = quote! {
impl GetSize for #name {}
impl ::get_size2::GetSize for #name {}
};
return gen.into();
}
Expand Down Expand Up @@ -137,7 +139,7 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {
let field_ident = syn::parse_str::<syn::Ident>(&field_ident).unwrap();

field_cmds.push(quote! {
let (total_add, tracker) = GetSize::get_heap_size_with_tracker(#field_ident, tracker);
let (total_add, tracker) = ::get_size2::GetSize::get_heap_size_with_tracker(#field_ident, tracker);
total += total_add;
});
}
Expand Down Expand Up @@ -165,7 +167,7 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {
field_idents.push(field_ident);

field_cmds.push(quote! {
let (total_add, tracker) = GetSize::get_heap_size_with_tracker(#field_ident, tracker);
let (total_add, tracker) = ::get_size2::GetSize::get_heap_size_with_tracker(#field_ident, tracker);
total += total_add;
});
}
Expand All @@ -190,16 +192,16 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {

// Build the trait implementation
let gen = quote! {
impl #impl_generics GetSize for #name #ty_generics #where_clause {
impl #impl_generics ::get_size2::GetSize for #name #ty_generics #where_clause {
fn get_heap_size(&self) -> usize {
let tracker = get_size2::StandardTracker::default();

let (total, _) = GetSize::get_heap_size_with_tracker(self, tracker);
let (total, _) = ::get_size2::GetSize::get_heap_size_with_tracker(self, tracker);

total
}

fn get_heap_size_with_tracker<TRACKER: get_size2::GetSizeTracker>(
fn get_heap_size_with_tracker<TRACKER: ::get_size2::GetSizeTracker>(
&self,
tracker: TRACKER,
) -> (usize, TRACKER) {
Expand All @@ -218,7 +220,7 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {
if data_struct.fields.is_empty() {
// Empty structs are easy to implement.
let gen = quote! {
impl GetSize for #name {}
impl ::get_size2::GetSize for #name {}
};
return gen.into();
}
Expand Down Expand Up @@ -252,13 +254,13 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {

if let Some(ident) = field.ident.as_ref() {
cmds.push(quote! {
let (total_add, tracker) = GetSize::get_heap_size_with_tracker(&self.#ident, tracker);
let (total_add, tracker) = ::get_size2::GetSize::get_heap_size_with_tracker(&self.#ident, tracker);
total += total_add;
});
} else {
let current_index = syn::Index::from(unidentified_fields_count);
cmds.push(quote! {
let (total_add, tracker) = GetSize::get_heap_size_with_tracker(&self.#current_index, tracker);
let (total_add, tracker) = ::get_size2::GetSize::get_heap_size_with_tracker(&self.#current_index, tracker);
total += total_add;
});

Expand All @@ -268,16 +270,16 @@ pub fn derive_get_size(input: TokenStream) -> TokenStream {

// Build the trait implementation
let gen = quote! {
impl #impl_generics GetSize for #name #ty_generics #where_clause {
impl #impl_generics ::get_size2::GetSize for #name #ty_generics #where_clause {
fn get_heap_size(&self) -> usize {
let tracker = get_size2::StandardTracker::default();

let (total, _) = GetSize::get_heap_size_with_tracker(self, tracker);
let (total, _) = ::get_size2::GetSize::get_heap_size_with_tracker(self, tracker);

total
}

fn get_heap_size_with_tracker<TRACKER: get_size2::GetSizeTracker>(
fn get_heap_size_with_tracker<TRACKER: ::get_size2::GetSizeTracker>(
&self,
tracker: TRACKER,
) -> (usize, TRACKER) {
Expand Down

0 comments on commit 067e8e3

Please sign in to comment.