alchemist51 commented on code in PR #9138: URL: https://github.com/apache/arrow-rs/pull/9138#discussion_r2751559818
########## arrow-memory-size/README.md: ########## @@ -0,0 +1,231 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# `arrow-memory-size` + +[](https://crates.io/crates/arrow-memory-size) +[](https://docs.rs/arrow-memory-size/latest/arrow_memory_size/) + +Memory size estimation utilities for [Apache Arrow]. + +This crate provides the `HeapSize` trait for calculating heap memory usage of data structures. + +[Apache Arrow]: https://arrow.apache.org/ + +## Why This Crate? + +Several memory size estimation crates exist in the Rust ecosystem ([deepsize], [get-size2], etc.), but none has emerged as a clear standard. Rather than take a dependency on any of them, this crate provides a minimal `HeapSize` trait with a small API surface that can be implemented across the Arrow ecosystem. + +Key motivations: + +- **Minimal API**: Just two methods (`heap_size()` and `total_size()`) Review Comment: That makes sense, thanks @adriangb! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
