Add the upsert and compute methods for modifying a cached entry #370

tatsuya6502 · 2023-12-31T02:50:54Z

This PR adds compute family-methods to the entry API. They take a closure to insert, update, or remove a value for a key depending on the current cached value.

Also bumps the version to v0.12.3.

API: `future::Cache`

/// Upsert (update or insert) the cached entry.
pub async fn and_upsert_with<F, Fut>(self, f: F) -> Entry<K, V>
where
    F: FnOnce(Option<Entry<K, V>>) -> Fut,
    Fut: Future<Output = V>;


/// Upsert, remove or nop (no-operation) on the cached entry.
pub async fn and_compute_with<F, Fut>(self, f: F) -> compute::CompResult<K, V>)
where
    F: FnOnce(Option<Entry<K, V>>) -> Fut,
    Fut: Future<Output = compute::Op<V>>;


/// When Ok(Op), upsert, remove or nop (no-operation) on the cached entry.
/// Otherwise return Err(E)
pub async fn and_try_compute_with<F, Fut, E>(
    self,
    f: F,
) -> Result<compute::CompResult<K, V>, E>
where
    F: FnOnce(Option<Entry<K, V>>) -> Fut,
    Fut: Future<Output = Result<compute::Op<V>, E>>,
    E: Send + Sync + 'static;

Examples

See the following examples in the examples directory of the compute-api branch:

counter_async.rs
- Uses the and_upsert_with method.
- Atomically increment a cached u64.
bounded_counter_async.rs
- Uses the and_compute_with method.
- Atomically increment a cached u64 but reset (remove) it when it is 2.
append_value_async.rs
- Uses the and_upsert_with method.
- Atomically append an i32 to a cached Arc<RwLock<Vec<i32>>>.
try_append_value_async.rs
- Uses the and_try_compute_with method.
- Atomically read an char and append to a cached Arc<RwLock<String>>, but reading can fail by EOF.

API: `sync::Cache` and `sync::SegmentedCache`

/// Upsert (update or insert) the cached entry.
pub fn and_upsert_with<F>(self, f: F) -> Entry<K, V>
where
    F: FnOnce(Option<Entry<K, V>>) -> V;


/// Upsert, remove or nop (no-operation) on the cached entry.
pub fn and_compute_with<F>(self, f: F) -> compute::CompResult<K, V>
where
    F: FnOnce(Option<Entry<K, V>>) -> compute::Op<V>;


/// When Ok(Op), upsert, remove or nop (no-operation) on the cached entry.
/// Otherwise return Err(E)
pub fn and_try_compute_with<F, E>(
    self,
    f: F,
) -> Result<compute::CompResult<K, V>, E>
where
    F: FnOnce(Option<Entry<K, V>>) -> Result<compute::Op<V>, E>,
    E: Send + Sync + 'static;

Tasks

future::Cache:

and_upsert_with method. (upsert: insert or update)
- Implementation.
- Automated tests.
- Documents.
- Examples.
and_compute_with method.
- Implementation.
- Automated tests.
- Documents.
- Examples.
and_try_compute_with method.
- Implementation.
- Automated tests.
- Documents.
- Examples.

sync::Cache, sync::SegmentedCache:

and_upsert_with method. (upsert: insert or update)
- Implementation.
- Automated tests.
- Documents.
- Examples.
and_compute_with method.
- Implementation.
- Automated tests.
- Documents.
- Examples.
and_try_compute_with method.
- Implementation.
- Automated tests.
- Documents.
- Examples.

…e::Cache`

of `future::Cache`

…sync::Cache`

Also update the change log.

access to the entry Also improve the docs and source code comments of the compute family methods.

`and_try_compute_with` methods

tatsuya6502 · 2024-01-07T10:28:54Z

I changed the return types of and_compute_with and and_try_compute_with methods (commit: aee7ebe).

`future::Cache`

-pub async fn and_compute_with<F, Fut>(self, f: F) -> (Option<Entry<K, V>>, compute::PerformedOp)
+pub async fn and_compute_with<F, Fut>(self, f: F) -> compute::CompResult<K, V>)
 where
     F: FnOnce(Option<Entry<K, V>>) -> Fut,
     Fut: Future<Output = compute::Op<V>>;

 pub async fn and_try_compute_with<F, Fut, E>(
     self,
     f: F,
-) -> Result<(Option<Entry<K, V>>, compute::PerformedOp), E>
+) -> Result<compute::CompResult<K, V>, E>
 where
     F: FnOnce(Option<Entry<K, V>>) -> Fut,
     Fut: Future<Output = Result<compute::Op<V>, E>>,
     E: Send + Sync + 'static;

`sync::Cache` and `sync::SegmentedCache`

-pub fn and_compute_with<F>(self, f: F) -> (Option<Entry<K, V>>, compute::PerformedOp)
+pub fn and_compute_with<F>(self, f: F) -> compute::CompResult<K, V>
 where
     F: FnOnce(Option<Entry<K, V>>) -> compute::Op<V>;

 pub fn and_try_compute_with<F, E>(
     self,
     f: F,
-) -> Result<(Option<Entry<K, V>>, compute::PerformedOp), E>
+) -> Result<compute::CompResult<K, V>, E>
 where
     F: FnOnce(Option<Entry<K, V>>) -> Result<compute::Op<V>, E>,
     E: Send + Sync + 'static;

tatsuya6502

Merging.

tatsuya6502 added this to the v0.12.3 milestone Dec 31, 2023

tatsuya6502 added the enhancement New feature or request label Dec 31, 2023

Compute API - Add entry and_upsert_with method to future::Cache

781988c

tatsuya6502 force-pushed the compute-api branch from 671c97d to 781988c Compare December 31, 2023 04:31

tatsuya6502 self-assigned this Dec 31, 2023

tatsuya6502 added 7 commits December 31, 2023 16:51

Compute API - Add is_updated method to Entry

5e409b5

rustfmt

39e9301

Compute API - Add entry and_compute_with method to future::Cache

64908f6

Compute API - Add entry and_compute_with method to future::Cache

c6ce7d5

Compute API - Add entry and_try_compute_with method to future::Cache

b936e00

Compute API - Add unit tests for the compute family methods in `futur…

cf6b1b6

…e::Cache`

Compute API - Add some docs on the entry and_try_compute_with method

6427668

of `future::Cache`

tatsuya6502 changed the title ~~Add the compute API for modifying a cached entry~~ Add the upsert and compute methods for modifying a cached entry Jan 3, 2024

tatsuya6502 mentioned this pull request Jan 3, 2024

Can Moka combine entries ? #353

Closed

tatsuya6502 linked an issue Jan 3, 2024 that may be closed by this pull request

Can Moka combine entries ? #353

Closed

tatsuya6502 mentioned this pull request Jan 3, 2024

Entry and_compute method for performing an insert, update, or remove operation with single closure #227

Closed

tatsuya6502 added 5 commits January 4, 2024 18:47

Compute API - Update the docs of the entry and_try_compute_with method

075e37f

of `future::Cache`

Update the roadmap

b992147

Compute API - Add entry and_try_compute_with and other methods to `…

e5b95c1

…sync::Cache`

Compute API - Add doc and examples for sync::Cache

3d16028

Bump the version to v0.12.3

3db436f

Also update the change log.

tatsuya6502 marked this pull request as ready for review January 6, 2024 08:22

tatsuya6502 added 2 commits January 6, 2024 18:46

Compute API - Change the compute family methods to record a read

6eff2d3

access to the entry Also improve the docs and source code comments of the compute family methods.

Compute API - Change the return type of the entry and_compute_with and

aee7ebe

`and_try_compute_with` methods

Compute API - Brush up the documents

472addc

tatsuya6502 commented Jan 8, 2024

View reviewed changes

tatsuya6502 merged commit cc36d72 into main Jan 8, 2024
39 checks passed

tatsuya6502 deleted the compute-api branch January 8, 2024 16:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the upsert and compute methods for modifying a cached entry #370

Add the upsert and compute methods for modifying a cached entry #370

tatsuya6502 commented Dec 31, 2023 •

edited

Loading

tatsuya6502 commented Jan 7, 2024 •

edited

Loading

tatsuya6502 left a comment

Add the upsert and compute methods for modifying a cached entry #370

Add the upsert and compute methods for modifying a cached entry #370

Conversation

tatsuya6502 commented Dec 31, 2023 • edited Loading

API: future::Cache

Examples

API: sync::Cache and sync::SegmentedCache

Tasks

tatsuya6502 commented Jan 7, 2024 • edited Loading

future::Cache

sync::Cache and sync::SegmentedCache

tatsuya6502 left a comment

Choose a reason for hiding this comment

tatsuya6502 commented Dec 31, 2023 •

edited

Loading

API: `future::Cache`

API: `sync::Cache` and `sync::SegmentedCache`

tatsuya6502 commented Jan 7, 2024 •

edited

Loading

`future::Cache`

`sync::Cache` and `sync::SegmentedCache`