5 unstable releases

0.4.3 Jan 2, 2024
0.4.0 Jan 18, 2023
0.3.2 Dec 2, 2022
0.2.1 Jan 1, 2022
0.2.0 Dec 24, 2021

#803 in Procedural macros

Download history 2245/week @ 2023-11-04 2684/week @ 2023-11-11 2611/week @ 2023-11-18 2776/week @ 2023-11-25 2793/week @ 2023-12-02 3320/week @ 2023-12-09 3405/week @ 2023-12-16 2814/week @ 2023-12-23 4737/week @ 2023-12-30 4641/week @ 2024-01-06 4260/week @ 2024-01-13 3829/week @ 2024-01-20 4551/week @ 2024-01-27 5090/week @ 2024-02-03 3415/week @ 2024-02-10 3842/week @ 2024-02-17

17,417 downloads per month
Used in 7 crates (via memoize)

MIT license

21KB
365 lines

memoize

Docs.rs Crates.rs CI

A #[memoize] attribute for somewhat simple Rust functions: That is, functions with one or more Clone-able arguments, and a Clone-able return type. That's it.

NEWS: The crate has been updated so that you don't need to separately import lru, lazy_static, and other dependencies. Now everything should work automatically. Remember to enable the full feature to use LRU caching and other additional features.

Read the documentation (cargo doc --open) for the sparse details, or take a look at the examples/, if you want to know more:

// From examples/test2.rs

use memoize::memoize;

#[memoize]
fn hello(arg: String, arg2: usize) -> bool {
  arg.len()%2 == arg2
}

fn main() {
  // `hello` is only called once here.
  assert!(! hello("World".to_string(), 0));
  assert!(! hello("World".to_string(), 0));
  // Sometimes one might need the original function.
  assert!(! memoized_original_hello("World".to_string(), 0));
}

This is expanded into (with a few simplifications):

std::thread_local! {
  static MEMOIZED_MAPPING_HELLO : RefCell<HashMap<(String, usize), bool>> = RefCell::new(HashMap::new());
}

pub fn memoized_original_hello(arg: String, arg2: usize) -> bool {
  arg.len() % 2 == arg2
}

#[allow(unused_variables)]
fn hello(arg: String, arg2: usize) -> bool {
  let ATTR_MEMOIZE_RETURN__ = MEMOIZED_MAPPING_HELLO.with(|ATTR_MEMOIZE_HM__| {
    let mut ATTR_MEMOIZE_HM__ = ATTR_MEMOIZE_HM__.borrow_mut();
    ATTR_MEMOIZE_HM__.get(&(arg.clone(), arg2.clone())).cloned()
  });
  if let Some(ATTR_MEMOIZE_RETURN__) = ATTR_MEMOIZE_RETURN__ {
    return ATTR_MEMOIZE_RETURN__;
  }

  let ATTR_MEMOIZE_RETURN__ = memoized_original_hello(arg.clone(), arg2.clone());

  MEMOIZED_MAPPING_HELLO.with(|ATTR_MEMOIZE_HM__| {
    let mut ATTR_MEMOIZE_HM__ = ATTR_MEMOIZE_HM__.borrow_mut();
    ATTR_MEMOIZE_HM__.insert((arg, arg2), ATTR_MEMOIZE_RETURN__.clone());
  });

  r
}

Further Functionality

As can be seen in the above example, each thread has its own cache by default. If you would prefer that every thread share the same cache, you can specify the SharedCache option like below to wrap the cache in a std::sync::Mutex. For example:

#[memoize(SharedCache)]
fn hello(key: String) -> ComplexStruct {
  // ...
}

You can choose to use an LRU cache. In fact, if you know that a memoized function has an unbounded number of different inputs, you should do this! In that case, use the attribute like this:

// From examples/test1.rs
// Compile with --features=full
use memoize::memoize;

#[derive(Debug, Clone)]
struct ComplexStruct {
  // ...
}

#[memoize(Capacity: 123)]
fn hello(key: String) -> ComplexStruct {
  // ...
}

Adding more caches and configuration options is relatively simple, and a matter of parsing attribute parameters. Currently, compiling will fail if you use a parameter such as Capacity without the feature full being enabled.

Another parameter is TimeToLive, specifying how long a cached value is allowed to live:

#[memoize(Capacity: 123, TimeToLive: Duration::from_secs(2))]

chrono::Duration is also possible, but would have to first be converted to std::time::Duration

#[memoize(TimeToLive: chrono::Duration::hours(3).to_std().unwrap())]

The cached value will never be older than duration provided and instead recalculated on the next request.

You can also specifiy a custom hasher, like AHash using CustomHasher.

#[memoize(CustomHasher: ahash::HashMap)]

As some hashers initializing functions other than new(), you can specifiy a HasherInit function call:

#[memoize(CustomHasher: FxHashMap, HasherInit: FxHashMap::default())]

Sometimes, you can't or don't want to store data as part of the cache. In those cases, you can use the Ignore parameter in the #[memoize] macro to ignore an argument. Any Ignored arguments no longer need to be Clone-able, since they are not stored as part of the argument set, and changing an Ignored argument will not trigger calling the function again. You can Ignore multiple arugments by specifying the Ignore parameter multiple times.

// `Ignore: count_calls` lets our function take a `&mut u32` argument, which is normally not
// possible because it is not `Clone`-able.
#[memoize(Ignore: count_calls)]
fn add(a: u32, b: u32, count_calls: &mut u32) -> u32 {
    // Keep track of the number of times the underlying function is called.
	*count_calls += 1;
	a + b
}

Flushing

If you memoize a function f, there will be a function called memoized_flush_f() that allows you to clear the memoization cache.

Contributions

...are always welcome! This being my first procedural-macros crate, I am grateful for improvements of functionality and style. Please send a pull request, and don't be discouraged if it takes a while for me to review it; I'm sometimes a bit slow to catch up here :) -- Lewin

Dependencies

~1.5MB
~34K SLoC