Skip to content

Add example of passing dyn trait instance #236

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,7 @@ required-features = ["async", "proc_macro"]
[[example]]
name = "expiring_sized_cache"
required-features = ["async_tokio_rt_multi_thread"]

[[example]]
name = "dyn_trait_pass"
required-features = [ "default" ]
62 changes: 62 additions & 0 deletions examples/dyn_trait_pass.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
use cached::proc_macro::cached;
use thiserror::Error;

#[allow(dead_code)]
#[derive(Error, Debug, PartialEq, Clone)]
enum ProcessorError {
#[error("error wile processing task :{0}")]
TaskError(String),
}

trait AnyTaskProcessor {
type Error;

fn execute(&self) -> Result<String, ProcessorError>;
}

struct CustomProcessor;

impl AnyTaskProcessor for CustomProcessor {
type Error = ProcessorError;

fn execute(&self) -> Result<String, Self::Error> {
Ok(String::from("hello world"))
}
}

#[cached(
time = 100, // Expires after 100 seconds
size = 1, // Cache size (1) elements
result = true, // Cache the Result type
key = "i32", // Necessary option for caching method result
convert = r##"{ 1 }"## // Necessary option for key -> used static integer for example only
)]
fn cached_execute(
processor: &(dyn AnyTaskProcessor<Error = ProcessorError> + Send + Sync),
) -> Result<String, ProcessorError> {
std::thread::sleep(std::time::Duration::from_secs(2));
let result = processor.execute()?;
Ok(result)
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
let mean_delay = 100u128;

let custom_processor = CustomProcessor {};

let start_time = std::time::Instant::now();
let result = cached_execute(&custom_processor)?;
let elapsed = start_time.elapsed();
assert_eq!(&result, "hello world");
assert!(elapsed.as_millis() >= mean_delay);

let start_time = std::time::Instant::now();
let result = cached_execute(&custom_processor)?;
let elapsed = start_time.elapsed();
assert_eq!(&result, "hello world");
assert!(elapsed.as_millis() < mean_delay);

println!("done!");

Ok(())
}