Stretto

https://docs.rs/stretto/0.8.4/stretto/
Admin
Stretto is a high-performance thread-safe memory-bound Rust cache with TinyLFU admission and Sampled...
Tokens:32,550
Snippets:438
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### finalize

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Builds the AsyncCache and starts all necessary threads. It requires a spawner function compatible with the async runtime being used.

```APIDOC
## finalize<SP, R>

### Description
Build Cache and start all threads needed by the Cache.
`spawner` is the spawn function for your async runtime. For example, if you use `tokio`, then pass `tokio::spawn` as spawner parameter.

### Method
`finalize`

### Parameters
#### Path Parameters
- **spawner** (SP) - Required - The spawn function for your async runtime.

### Request Example
```rust
use stretto::{AsyncCacheBuilder, TransparentKeyBuilder};

AsyncCacheBuilder::<u64, u64>::new(100, 10)
    .finalize(tokio::spawn)
    .unwrap();
```

### Response
#### Success Response (Result<AsyncCache<K, V, KH, C, U, CB, S>, CacheError>)
- Returns the constructed `AsyncCache` on success.
- Returns a `CacheError` on failure.
```

--------------------------------

### CacheBuilder::finalize

Source: https://docs.rs/stretto/0.8.4/stretto/struct.CacheBuilder.html

Builds the cache and starts all necessary threads. This is the final step in configuring and initializing the cache.

```APIDOC
## CacheBuilder::finalize

### Description
Builds the Cache and starts all required threads. This method finalizes the cache construction process.

### Method
`finalize(self) -> Result<Cache<K, V, KH, C, U, CB, S>, CacheError>`

### Returns
A `Result` containing the initialized `Cache` on success, or a `CacheError` on failure.
```

--------------------------------

### Set Insert Buffer Items

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Configures the size of the Get buffers. Using 64 typically yields good performance for most use cases.

```rust
builder.set_buffer_items(64);
```

--------------------------------

### Get Value

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`get` retrieves a reference to the value associated with a given key, if it exists and has not expired.

```APIDOC
## pub async fn get<Q>(&self, key: &Q) -> Option<ValueRef<'_, V, S>>
where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

### Description
Retrieves a reference to the value associated with the given key from the cache.

### Parameters
- **key** (&Q) - The key to look up. Must be borrowable from K.

### Returns
- **Option<ValueRef<'_, V, S>>** - An Option containing a reference to the value if found, otherwise None.
```

--------------------------------

### get

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Retrieves a reference to a value from the Cache by key, if it exists and is not expired.

```APIDOC
## get

### Description
Retrieves a reference to a value from the Cache by key, if it exists and is not expired.

### Method
`get`

### Parameters
- `key` (*&Q*) - The key to look up.

### Returns
- `Option<ValueRef<'_, V, S>>` - An Option containing a reference to the value if found, otherwise None.
```

--------------------------------

### Finalize AsyncCacheBuilder with Tokio Spawner

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Builds the cache and starts necessary threads. Pass your async runtime's spawn function, such as `tokio::spawn`, to this method.

```rust
use stretto::{AsyncCacheBuilder, TransparentKeyBuilder};

AsyncCacheBuilder::<u64, u64>::new(100, 10)
    .finalize(tokio::spawn)
    .unwrap();
```

--------------------------------

### Get Keys Evicted

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the total count of keys that have been evicted from the cache.

```rust
pub fn get_keys_evicted(&self) -> Option<u64>
```

--------------------------------

### Get Cost Evicted

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the sum of costs for all items that have been evicted from the cache.

```rust
pub fn get_cost_evicted(&self) -> Option<u64>
```

--------------------------------

### Get Sets Rejected

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of Set calls that were rejected by the cache's policy, such as TinyLFU.

```rust
pub fn get_sets_rejected(&self) -> Option<u64>
```

--------------------------------

### Calculate Hit Ratio

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Calculates the ratio of Hits to total accesses (Hits + Misses), representing the percentage of successful Get calls.

```rust
pub fn ratio(&self) -> Option<f64>
```

--------------------------------

### Cache::new_with_key_builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Returns a Cache instance with default configurations and a custom key builder. Requires the `sync` feature flag.

```APIDOC
## Cache::new_with_key_builder

### Description
Returns a Cache instance with default configurations and a custom key builder.

### Method
`new_with_key_builder(num_counters: usize, max_cost: i64, index: KH) -> Result<Self, CacheError>`

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost the cache can hold.
* `index` (KH) - The custom key builder to use.

### Response
* `Result<Self, CacheError>` - A `Result` containing the `Cache` instance or a `CacheError`.
```

--------------------------------

### Get Gets Dropped

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of internal Get counter increments that were dropped.

```rust
pub fn get_gets_dropped(&self) -> Option<u64>
```

--------------------------------

### Get Gets Kept

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of internal Get counter increments that were successfully processed.

```rust
pub fn get_gets_kept(&self) -> Option<u64>
```

--------------------------------

### Create a new Cache with a custom KeyBuilder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Initializes a Cache instance with default configurations and a provided KeyBuilder. Requires specifying the number of counters and maximum cost.

```rust
pub fn new_with_key_builder(
 num_counters: usize,
 max_cost: i64,
 index: KH,
 ) -> Result<Self, CacheError>
```

--------------------------------

### Cache::new

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Returns a Cache instance with default configurations. Requires the `sync` feature flag.

```APIDOC
## Cache::new

### Description
Returns a Cache instance with default configurations.

### Method
`new(num_counters: usize, max_cost: i64) -> Result<Self, CacheError>`

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost the cache can hold.

### Response
* `Result<Self, CacheError>` - A `Result` containing the `Cache` instance or a `CacheError`.
```

--------------------------------

### Create a new Cache instance

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Initializes a Cache instance with default configurations. Requires specifying the number of counters and maximum cost.

```rust
pub fn new(num_counters: usize, max_cost: i64) -> Result<Self, CacheError>
```

--------------------------------

### Get Type ID

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Histogram.html

Implements the `Any` trait, providing a method to get the `TypeId` of the Histogram instance.

```rust
fn type_id(&self) -> TypeId>
```

--------------------------------

### Get Cache Misses

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of Get calls where a value was not found for the requested key.

```rust
pub fn get_misses(&self) -> Option<u64>
```

--------------------------------

### Create New CacheBuilder with Key Builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.CacheBuilder.html

Initializes a new CacheBuilder with a custom KeyBuilder. Use this when you need a specific hashing algorithm for cache keys.

```rust
pub fn new_with_key_builder(num_counters: usize, max_cost: i64, kh: KH) -> Self
```

--------------------------------

### Create AsyncCache with Tokio Spawner

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Instantiates an AsyncCache with default configurations using tokio::spawn for async operations. Requires specifying the number of counters and maximum cost.

```rust
use stretto::AsyncCache;

AsyncCache::<u64, u64>::new(100, 10, tokio::spawn).unwrap();
```

--------------------------------

### Get Cache Hits

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of successful Get calls where a value was found for the requested key.

```rust
pub fn get_hits(&self) -> Option<u64>
```

--------------------------------

### Create AsyncCache with TransparentKeyBuilder and Tokio Spawner

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Instantiates an AsyncCache with a custom TransparentKeyBuilder and tokio::spawn for async operations. Requires specifying the number of counters and maximum cost.

```rust
use stretto::{AsyncCache, TransparentKeyBuilder};

AsyncCache::<u64, u64, TransparentKeyBuilder<_>>::new_with_key_builder(100, 10, TransparentKeyBuilder::<u64>::default(), tokio::spawn).unwrap();
```

--------------------------------

### CloneToUninit

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Performs copy-assignment from `self` to `dest`. This is a nightly-only experimental API.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
Performs copy-assignment from `self` to `dest`.

### Safety
This function is unsafe because it performs raw pointer manipulation. The caller must ensure that `dest` is a valid, mutable pointer to a region of memory large enough to hold a `T`.

### Parameters
- **dest** (*mut u8) - A mutable pointer to the destination memory location.
```

--------------------------------

### Metrics::get_gets_dropped()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of internal Get counter increments that were dropped.

```APIDOC
## Metrics::get_gets_dropped()

### Description
Returns the number of Get counter increments that are dropped internally.

### Method
`pub fn get_gets_dropped(&self) -> Option<u64>`
```

--------------------------------

### AsyncCache::new

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Constructs a new AsyncCache instance with default configurations. Requires a spawner function compatible with the async runtime.

```APIDOC
## AsyncCache::new

### Description
Returns a Cache instance with default configruations.

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost capacity of the cache.
* `spawner` (SP) - The spawn function for your async runtime (e.g., `tokio::spawn`).

### Returns
* `Result<Self, CacheError>` - A new instance of AsyncCache or a CacheError.

### Example
```rust
use stretto::AsyncCache;

AsyncCache::<u64, u64>::new(100, 10, tokio::spawn).unwrap();
```
```

--------------------------------

### Metrics::get_gets_kept()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of internal Get counter increments that were successfully processed.

```APIDOC
## Metrics::get_gets_kept()

### Description
Returns the number of Get counter increments that are kept.

### Method
`pub fn get_gets_kept(&self) -> Option<u64>`
```

--------------------------------

### Create Op Metrics

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Use this function to create a Metrics instance that will track operational statistics.

```rust
pub fn new_op() -> Self
```

--------------------------------

### Metrics::get_misses()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of Get calls where a value was not found for the requested key.

```APIDOC
## Metrics::get_misses()

### Description
Returns the number of Get calls where a value was not found for the corresponding key.

### Method
`pub fn get_misses(&self) -> Option<u64>`
```

--------------------------------

### TransparentKeyBuilder Methods

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentKeyBuilder.html

This section details the methods available on the TransparentKeyBuilder for hashing and building keys, as part of the KeyBuilder trait implementation.

```APIDOC
## impl<K: TransparentKey> KeyBuilder for TransparentKeyBuilder<K>

### Description
Implementation of the `KeyBuilder` trait for `TransparentKeyBuilder`.

### Methods

#### `hash_index<Q>(&self, key: &Q) -> u64`

##### Description
`hash_index` is used to hash the key to u64.

##### Parameters
- `key`: A reference to the key to be hashed.

##### Returns
A `u64` hash value.

#### `hash_conflict<Q>(&self, _key: &Q) -> u64`

##### Description
If you want 128-bit hashes, you should implement this method. Otherwise, it returns 0.

##### Parameters
- `_key`: A reference to the key (unused in the default implementation).

##### Returns
A `u64` value, typically 0 if not implemented for 128-bit hashing.

#### `build_key<Q>(&self, k: &Q) -> (u64, u64)`

##### Description
Builds a 128-bit hash from the given key.

##### Parameters
- `k`: A reference to the key to build the hash from.

##### Returns
A tuple of two `u64` values representing the 128-bit hash.
```

--------------------------------

### Metrics::get_hits()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of successful Get calls where a value was found for the requested key.

```APIDOC
## Metrics::get_hits()

### Description
Returns the number of Get calls where a value was found for the corresponding key.

### Method
`pub fn get_hits(&self) -> Option<u64>`
```

--------------------------------

### AsyncCache::new_with_key_builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Constructs a new AsyncCache instance with a custom key builder. Requires a spawner function compatible with the async runtime.

```APIDOC
## AsyncCache::new_with_key_builder

### Description
Returns a Cache instance with default configruations, allowing for a custom key builder.

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost capacity of the cache.
* `index` (KH) - The key builder to use for the cache.
* `spawner` (SP) - The spawn function for your async runtime (e.g., `tokio::spawn`).

### Returns
* `Result<Self, CacheError>` - A new instance of AsyncCache or a CacheError.

### Example
```rust
use stretto::{AsyncCache, TransparentKeyBuilder};

AsyncCache::<u64, u64, TransparentKeyBuilder<_>>::new_with_key_builder(100, 10, TransparentKeyBuilder::<u64>::default(), tokio::spawn).unwrap();
```
```

--------------------------------

### Get TTL

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`get_ttl` returns the remaining time-to-live (TTL) for a specified key if the item is found and not expired.

```APIDOC
## pub fn get_ttl<Q>(&self, key: &Q) -> Option<Duration>
where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

### Description
Returns the time-to-live (TTL) duration for the specified key if the item exists in the cache and has not expired.

### Parameters
- **key** (&Q) - The key for which to retrieve the TTL.

### Returns
- **Option<Duration>** - An Option containing the Duration of the TTL if the key is found and valid, otherwise None.
```

--------------------------------

### Implementations on Foreign Types

Source: https://docs.rs/stretto/0.8.4/stretto/trait.TransparentKey.html

Demonstrates implementations of the TransparentKey trait for various primitive types.

```APIDOC
### impl TransparentKey for bool

#### fn to_u64(&self) -> u64

### impl TransparentKey for i8

#### fn to_u64(&self) -> u64

### impl TransparentKey for i16

#### fn to_u64(&self) -> u64

### impl TransparentKey for i32

#### fn to_u64(&self) -> u64

### impl TransparentKey for i64

#### fn to_u64(&self) -> u64

### impl TransparentKey for isize

#### fn to_u64(&self) -> u64

### impl TransparentKey for u8

#### fn to_u64(&self) -> u64

### impl TransparentKey for u16

#### fn to_u64(&self) -> u64

### impl TransparentKey for u32

#### fn to_u64(&self) -> u64

### impl TransparentKey for u64

#### fn to_u64(&self) -> u64

### impl TransparentKey for usize

#### fn to_u64(&self) -> u64
```

--------------------------------

### Try Insert with TTL

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`try_insert_with_ttl` is the non-panicking version of `insert_with_ttl`, returning a Result.

```APIDOC
## pub async fn try_insert_with_ttl( &self, key: K, val: V, cost: i64, ttl: Duration, ) -> Result<bool, CacheError>

### Description
Attempts to insert a key-value pair into the cache with a specified TTL, returning a Result.

### Parameters
- **key** (K) - The key to insert.
- **val** (V) - The value to insert.
- **cost** (i64) - The cost associated with the value.
- **ttl** (Duration) - The time-to-live for the entry.

### Returns
- **Result<bool, CacheError>** - Ok(true) if successful, Ok(false) if not, or Err(CacheError) if an error occurred.
```

--------------------------------

### type_id Method

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Item.html

Gets the TypeId of the Item. This is part of the Any trait implementation and requires the type T to be 'static and sized.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Create a Cache Builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Returns a CacheBuilder to configure a Cache instance with custom parameters. Requires specifying the number of counters and maximum cost.

```rust
pub fn builder(
 num_counters: usize,
 max_cost: i64,
 ) -> CacheBuilder<K, V, DefaultKeyBuilder<K>, DefaultCoster<V>, DefaultUpdateValidator<V>, DefaultCacheCallback<V>, RandomState>
```

--------------------------------

### Get Mutable Value

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`get_mut` retrieves a mutable reference to the value associated with a given key, if it exists and has not expired.

```APIDOC
## pub async fn get_mut<Q>(&self, key: &Q) -> Option<ValueRefMut<'_, V, S>>
where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

### Description
Retrieves a mutable reference to the value associated with the given key from the cache.

### Parameters
- **key** (&Q) - The key to look up. Must be borrowable from K.

### Returns
- **Option<ValueRefMut<'_, V, S>>** - An Option containing a mutable reference to the value if found, otherwise None.
```

--------------------------------

### on_evict Method Signature

Source: https://docs.rs/stretto/0.8.4/stretto/trait.CacheCallback.html

The `on_evict` method is called for each eviction, providing the item's key, value, and cost. Implement this to perform actions related to evicted cache items.

```rust
fn on_evict(&self, item: Item<Self::Value>) { ... }
```

--------------------------------

### Get Sets Dropped

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the count of Set calls that were not processed due to internal issues like contention.

```rust
pub fn get_sets_dropped(&self) -> Option<u64>
```

--------------------------------

### AsyncCacheBuilder::new_with_key_builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Creates a new AsyncCacheBuilder with a custom key builder.

```APIDOC
## AsyncCacheBuilder::new_with_key_builder

### Description
Creates a new AsyncCacheBuilder with the specified number of counters, maximum cost, and a custom key builder.

### Signature
```rust
pub fn new_with_key_builder<KH: KeyBuilder<Key = K>>(num_counters: usize, max_cost: i64, kh: KH) -> Self
```

### Parameters
- **num_counters** (usize) - The number of 4-bit access counters.
- **max_cost** (i64) - The maximum cost for eviction decisions.
- **kh** (KH) - The custom KeyBuilder implementation.
```

--------------------------------

### from Method

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Item.html

Creates an Item from a value of the same type. This is part of the From trait implementation.

```rust
fn from(t: T) -> T
```

--------------------------------

### Get Cost Added

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the sum of costs for all items successfully added to the cache via Set calls.

```rust
pub fn get_cost_added(&self) -> Option<u64>
```

--------------------------------

### build_key Method for 128-bit Hashes

Source: https://docs.rs/stretto/0.8.4/stretto/trait.KeyBuilder.html

This method is used to construct a 128-bit hash for a given key, returning a tuple of two u64 values.

```rust
fn build_key<Q>(&self, k: &Q) -> (u64, u64)
   where Self::Key: Borrow<Q>,
         Q: Hash + Eq + ?Sized {
    // ...
}
```

--------------------------------

### Get Life Expectancy Histogram

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Returns the histogram data related to the life expectancy of items within the cache metrics.

```rust
pub fn life_expectancy_seconds(&self) -> Option<Histogram>
```

--------------------------------

### Get Keys Updated

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the total count of Set calls that resulted in an existing key's value being updated.

```rust
pub fn get_keys_updated(&self) -> Option<u64>
```

--------------------------------

### Cache::builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Returns a CacheBuilder instance to configure a new Cache. Requires the `sync` feature flag.

```APIDOC
## Cache::builder

### Description
Returns a Builder for configuring a Cache instance.

### Method
`builder(num_counters: usize, max_cost: i64) -> CacheBuilder<K, V, DefaultKeyBuilder<K>, DefaultCoster<V>, DefaultUpdateValidator<V>, DefaultCacheCallback<V>, RandomState>`

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost the cache can hold.

### Response
* `CacheBuilder<...>` - A `CacheBuilder` instance to further configure the cache.
```

--------------------------------

### Get Keys Added

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Retrieves the total count of Set calls that resulted in a new key-value item being added to the cache.

```rust
pub fn get_keys_added(&self) -> Option<u64>
```

--------------------------------

### DefaultKeyBuilder build_key implementation

Source: https://docs.rs/stretto/0.8.4/stretto/struct.DefaultKeyBuilder.html

The build_key method constructs a 128-bit hash representation of the key. This is used for more granular key identification within the cache.

```rust
fn build_key<Q>(&self, k: &Q) -> (u64, u64)
where Self::Key: Borrow<Q>, Q: Hash + Eq + ?Sized,
```

--------------------------------

### Get Expiration Time

Source: https://docs.rs/stretto/0.8.4/stretto/struct.ValueRef.html

Retrieves the time-to-live (TTL) duration for the cached value. This indicates how long the value is valid in the cache.

```rust
pub fn ttl(&self) -> Duration
```

--------------------------------

### DefaultKeyBuilder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.DefaultKeyBuilder.html

DefaultKeyBuilder is a built-in `KeyBuilder` for the Cache. If the key implements `TransparentKey` trait, use `TransparentKeyBuilder`. u8, u16, u32, u64, i8, i16, i32, i64, bool implement `TransparentKey` by default. See `KeyBuilder` if you want to write a customized `KeyBuilder`.

```APIDOC
## DefaultKeyBuilder

### Description
DefaultKeyBuilder is a built-in `KeyBuilder` for the Cache. It is used when the key type does not implement the `TransparentKey` trait. For types that do implement `TransparentKey` (like primitive integers and booleans), `TransparentKeyBuilder` should be used instead. Refer to the `KeyBuilder` trait documentation for details on creating custom key builders.

### Type Parameters
* `K`: The type of the key, which must implement `Hash` and `Eq`.

### Trait Implementations

#### `KeyBuilder` for `DefaultKeyBuilder<K>`
This implementation provides the core functionality for hashing keys.

##### `type Key = K`

##### `fn hash_index<Q>(&self, key: &Q) -> u64`
* Description: Computes a `u64` hash index for the given key.
* Parameters:
  * `key` (&Q): The key to hash. `Q` must be comparable to `K` (`K: Borrow<Q>`) and implement `Hash` and `Eq`.
* Returns: A `u64` hash index.

##### `fn hash_conflict<Q>(&self, key: &Q) -> u64`
* Description: Used for generating 128-bit hashes. If not implemented or returns 0, it implies 64-bit hashing is sufficient.
* Parameters:
  * `key` (&Q): The key to hash.
* Returns: A `u64` value, typically 0 if not used for 128-bit hashing.

##### `fn build_key<Q>(&self, k: &Q) -> (u64, u64)`
* Description: Builds a 128-bit hash representation of the key.
* Parameters:
  * `k` (&Q): The key to build the hash from.
* Returns: A tuple of two `u64` values representing the 128-bit hash.
```

--------------------------------

### Initialize Histogram

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Histogram.html

Creates a new Histogram instance with specified bounds. The bounds define the range of exponents for the histogram, typically powers of two.

```rust
pub fn new(bounds: Vec<f64>) -> Self>
```

--------------------------------

### Get Inner Value Reference

Source: https://docs.rs/stretto/0.8.4/stretto/struct.ValueRef.html

Retrieves a reference to the inner value stored within the ValueRef. This method is available for all ValueRef instances.

```rust
pub fn value(&self) -> &V
```

--------------------------------

### impl PartialEq for TransparentHasher

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentHasher.html

Provides equality comparison for TransparentHasher.

```APIDOC
## impl PartialEq for TransparentHasher

### fn eq(&self, other: &TransparentHasher) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.

### fn ne(&self, other: &Rhs) -> bool

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
```

--------------------------------

### DefaultKeyBuilder Key Type Implementation

Source: https://docs.rs/stretto/0.8.4/stretto/trait.KeyBuilder.html

Shows the Key type implementation for DefaultKeyBuilder, which is generic over K where K implements Hash and Eq.

```rust
type Key = K;
```

--------------------------------

### Get Mutable Inner Value Reference - Rust

Source: https://docs.rs/stretto/0.8.4/stretto/struct.ValueRefMut.html

Retrieves a mutable reference to the inner value, allowing in-place modifications. Use this when you need to change the value directly.

```rust
pub fn value_mut(&mut self) -> &mut V
```

--------------------------------

### CacheBuilder::new

Source: https://docs.rs/stretto/0.8.4/stretto/struct.CacheBuilder.html

Creates a new CacheBuilder with the specified number of counters and maximum cost. This is the basic constructor for customizing cache settings.

```APIDOC
## CacheBuilder::new

### Description
Creates a new Builder with the specified number of counters and maximum cost.

### Signature
```rust
pub fn new(num_counters: usize, max_cost: i64) -> Self
```

### Parameters
- **num_counters** (usize) - The number of 4-bit access counters to keep for admission and eviction.
- **max_cost** (i64) - The maximum cost for eviction decisions. Can also denote max size in bytes.
```

--------------------------------

### TryInto<U> for T

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Provides functionality to attempt conversion into another type, leveraging `TryFrom`.

```APIDOC
## type Error = <U as TryFrom<T>>::Error

### Description
The type returned in the event of a conversion error.

## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

### Description
Performs the conversion.

### Method
`try_into`

### Parameters
None

### Response
- **Result<U, <U as TryFrom<T>>::Error>**: Ok(U) if conversion is successful, Err(Error) otherwise.
```

--------------------------------

### Create Noop Metrics

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Use this function to create a Metrics instance that represents no operations.

```rust
pub const fn new() -> Self
```

--------------------------------

### Create New CacheBuilder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.CacheBuilder.html

Initializes a new CacheBuilder with the specified number of counters and maximum cost. This is the basic constructor for the builder.

```rust
pub fn new(num_counters: usize, max_cost: i64) -> Self
```

--------------------------------

### WithSubscriber for T

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentHasher.html

Implementation for attaching subscribers.

```APIDOC
## impl<T> WithSubscriber for T

### Description
Allows attaching a subscriber to the type `T`.

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>

### Description
Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Parameters
* **subscriber** (*S*) - The subscriber to attach. Must be convertible into a `Dispatch`.

### Returns
A `WithDispatch` wrapper containing the type and the attached subscriber.

#### fn with_current_subscriber(self) -> WithDispatch<Self>

### Description
Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper.

### Returns
A `WithDispatch` wrapper containing the type and the attached default subscriber.
```

--------------------------------

### Try Insert into AsyncCache

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

A non-panicking asynchronous version of `insert`. Attempts to insert a key-value pair with a specified cost. Returns a Result indicating success or a CacheError.

```rust
pub async fn try_insert(
    &self,
    key: K,
    val: V,
    cost: i64,
) -> Result<bool, CacheError>
```

--------------------------------

### impl Clone for TransparentHasher

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentHasher.html

Provides cloning functionality for TransparentHasher.

```APIDOC
## impl Clone for TransparentHasher

### fn clone(&self) -> TransparentHasher

Returns a duplicate of the value. Read more

### fn clone_from(&mut self, source: &Self)

Performs copy-assignment from `source`. Read more
```

--------------------------------

### Try Insert if Present

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`try_insert_if_present` is the non-panicking version of `insert_if_present`, returning a Result.

```APIDOC
## pub async fn try_insert_if_present( &self, key: K, val: V, cost: i64, ) -> Result<bool, CacheError>

### Description
Attempts to update the value of an existing key in the cache if the key is present, returning a Result.

### Parameters
- **key** (K) - The key whose value needs to be updated.
- **val** (V) - The new value.
- **cost** (i64) - The cost associated with the new value.

### Returns
- **Result<bool, CacheError>** - Ok(true) if the key was present and updated, Ok(false) if the key was not present, or Err(CacheError) if an error occurred.
```

--------------------------------

### Cache::try_insert_with_ttl

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert_with_ttl`. Requires the `sync` feature flag.

```APIDOC
## Cache::try_insert_with_ttl

### Description
The non-panicking version of `insert_with_ttl`, inserting a key-value pair with a time-to-live (TTL).

### Method
`try_insert_with_ttl(&self, key: K, val: V, cost: i64, ttl: Duration) -> Result<bool, CacheError>`

### Parameters
* `key` (K) - The key to insert.
* `val` (V) - The value to insert.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.
* `ttl` (Duration) - The time-to-live for the item.

### Response
* `Result<bool, CacheError>` - A `Result` containing `true` if the item was inserted (or has a chance to be kept), `false` if the insert was dropped, or a `CacheError`.
```

--------------------------------

### VZip<V> for T

Source: https://docs.rs/stretto/0.8.4/stretto/enum.MetricType.html

Provides a generic implementation for zipping with a MultiLane.

```APIDOC
## VZip<V> for T

### Description
Provides a generic implementation for zipping a type `T` with a `MultiLane` of type `V`.

### Signature
`fn vzip(self) -> V`
```

--------------------------------

### CacheBuilder::new_with_key_builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.CacheBuilder.html

Creates a new CacheBuilder with a custom KeyBuilder, along with the number of counters and maximum cost. This allows for advanced control over key hashing.

```APIDOC
## CacheBuilder::new_with_key_builder

### Description
Creates a new AsyncCacheBuilder with a custom KeyBuilder.

### Signature
```rust
pub fn new_with_key_builder<KH: KeyBuilder<Key = K>>(num_counters: usize, max_cost: i64, kh: KH) -> Self
```

### Parameters
- **num_counters** (usize) - The number of 4-bit access counters to keep for admission and eviction.
- **max_cost** (i64) - The maximum cost for eviction decisions.
- **kh** (KH) - An implementation of the `KeyBuilder` trait for custom key hashing.
```

--------------------------------

### Cache::try_insert

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert`. Requires the `sync` feature flag.

```APIDOC
## Cache::try_insert

### Description
The non-panicking version of `insert`, attempting to insert a key-value pair into the cache with a specified cost.

### Method
`try_insert(&self, key: K, val: V, cost: i64) -> Result<bool, CacheError>`

### Parameters
* `key` (K) - The key to insert.
* `val` (V) - The value to insert.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.

### Response
* `Result<bool, CacheError>` - A `Result` containing `true` if the item was inserted (or has a chance to be kept), `false` if the insert was dropped, or a `CacheError`.
```

--------------------------------

### Metrics::new_op()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Creates a new Metrics instance with the Op variant, ready to track operation statistics.

```APIDOC
## Metrics::new_op()

### Description
Create a new op metrics

### Method
`pub fn new_op() -> Self`
```

--------------------------------

### clone_to_uninit Method (Nightly)

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Item.html

Performs copy-assignment from the Item to an uninitialized memory location. This is a nightly-only experimental API and requires the type T to implement Clone.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Set Custom Key Builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Assigns a custom `KeyBuilder` for hashing cache keys. If your key implements `TransparentKey`, `TransparentKeyBuilder` is faster. Otherwise, `DefaultKeyBuilder` is suitable. You can also implement your own `KeyBuilder` trait.

```rust
builder.set_key_builder(TransparentKeyBuilder);

```

--------------------------------

### AsyncCacheBuilder::new

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Creates a new AsyncCacheBuilder with the specified number of counters and maximum cost.

```APIDOC
## AsyncCacheBuilder::new

### Description
Creates a new AsyncCacheBuilder with the specified number of counters and maximum cost.

### Signature
```rust
pub fn new(num_counters: usize, max_cost: i64) -> Self
```

### Parameters
- **num_counters** (usize) - The number of 4-bit access counters.
- **max_cost** (i64) - The maximum cost for eviction decisions.
```

--------------------------------

### Try to insert a key-value item into the Cache

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert`. Attempts to add a key-value item to the cache with a specified cost.

```rust
pub fn try_insert(&self, key: K, val: V, cost: i64) -> Result<bool, CacheError>
```

--------------------------------

### Metrics::new()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Creates a new Metrics instance with the Noop variant, indicating no operations have been tracked.

```APIDOC
## Metrics::new()

### Description
Create a Noop metrics

### Method
`pub const fn new() -> Self`
```

--------------------------------

### AsyncCache::try_insert

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Asynchronously attempts to insert a key-value pair into the cache with a specified cost, returning a Result.

```APIDOC
## AsyncCache::try_insert

### Description
Asynchronously attempts to insert a key-value pair into the cache. This is the non-panicking version of `insert`.

### Method
`pub async fn try_insert(&self, key: K, val: V, cost: i64) -> Result<bool, CacheError>`

### Parameters
* `key` (K) - The key to insert.
* `val` (V) - The value to insert.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.

### Returns
* `Result<bool, CacheError>` - `Ok(true)` if the item was inserted, `Ok(false)` if the insertion was dropped, or `Err(CacheError)` if an error occurred.
```

--------------------------------

### Enable Metrics Recording

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Enables or disables the recording of cache metrics. Enabling metrics can introduce a ~10% throughput overhead.

```rust
builder.set_metrics(true);
```

--------------------------------

### on_reject Method Signature

Source: https://docs.rs/stretto/0.8.4/stretto/trait.CacheCallback.html

The `on_reject` method is called for each rejection made by the cache policy. Use this to handle items that were rejected by the cache's internal logic.

```rust
fn on_reject(&self, item: Item<Self::Value>) { ... }
```

--------------------------------

### Try to insert a key-value item with a Time-To-Live (TTL)

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert_with_ttl`. Adds a key-value pair to the cache that will expire after the specified TTL.

```rust
pub fn try_insert_with_ttl(
 &self,
 key: K,
 val: V,
 cost: i64,
 ttl: Duration,
 ) -> Result<bool, CacheError>
```

--------------------------------

### Cache::insert

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Attempts to insert a key-value pair into the cache with a specified cost. Requires the `sync` feature flag.

```APIDOC
## Cache::insert

### Description
Attempts to add the key-value item to the cache with a specified cost. If it returns false, the insert was dropped. If it returns true, the item is added, and other items may be evicted.
To dynamically evaluate the item's cost using the `Config.Coster` function, set the cost parameter to 0.

### Method
`insert(&self, key: K, val: V, cost: i64) -> bool`

### Parameters
* `key` (K) - The key to insert.
* `val` (V) - The value to insert.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.

### Response
* `bool` - `true` if the item was inserted (or has a chance to be kept), `false` if the insert was dropped.
```

--------------------------------

### TryFrom<U> for T

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Provides functionality to attempt conversion from one type to another, with a defined error type.

```APIDOC
## type Error = Infallible

### Description
The type returned in the event of a conversion error.

## fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

### Description
Performs the conversion.

### Method
`try_from`

### Parameters
- **value** (U): The value to convert.

### Response
- **Result<T, <T as TryFrom<U>>::Error>**: Ok(T) if conversion is successful, Err(Error) otherwise.
```

--------------------------------

### AsyncCache::builder

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Returns a builder for configuring a new AsyncCache instance.

```APIDOC
## AsyncCache::builder

### Description
Returns a Builder for creating an AsyncCache instance with custom configurations.

### Parameters
* `num_counters` (usize) - The number of counters for the cache.
* `max_cost` (i64) - The maximum cost capacity of the cache.

### Returns
* `AsyncCacheBuilder<K, V, DefaultKeyBuilder<K>, DefaultCoster<V>, DefaultUpdateValidator<V>, DefaultCacheCallback<V>, RandomState>` - An AsyncCacheBuilder instance.
```

--------------------------------

### clone_into

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentHasher.html

Uses borrowed data to replace owned data, usually by cloning.

```APIDOC
## fn clone_into(&self, target: &mut T)

### Description
Uses borrowed data to replace owned data, usually by cloning.

### Parameters
* **target** (*&mut T*) - The mutable reference to the target where the data will be cloned into.
```

--------------------------------

### Cache::try_insert_if_present

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert_if_present`. Requires the `sync` feature flag.

```APIDOC
## Cache::try_insert_if_present

### Description
The non-panicking version of `insert_if_present`, updating the value of an existing key only if the key is present in the cache.

### Method
`try_insert_if_present(&self, key: K, val: V, cost: i64) -> Result<bool, CacheError>`

### Parameters
* `key` (K) - The key to update.
* `val` (V) - The new value to associate with the key.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.

### Response
* `Result<bool, CacheError>` - A `Result` containing `true` if the key was present and the value was updated, `false` otherwise, or a `CacheError`.
```

--------------------------------

### Metrics::ratio()

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Calculates and returns the ratio of Hits to total accesses (Hits + Misses), representing the hit rate of the cache.

```APIDOC
## Metrics::ratio()

### Description
Ratio is the number of Hits over all accesses (Hits + Misses). This is the percentage of successful Get calls.

### Method
`pub fn ratio(&self) -> Option<f64>`
```

--------------------------------

### Clone to Uninit (Nightly)

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Histogram.html

Implements the nightly-only experimental `CloneToUninit` trait for Histogram, allowing copying to uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)>
```

--------------------------------

### into Method

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Item.html

Converts the Item into another type U, provided that U implements From<T>. This is part of the Into trait.

```rust
fn into(self) -> U
```

--------------------------------

### Insert a key-value item with a Time-To-Live (TTL)

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Adds a key-value pair to the cache that will expire after the specified TTL. A zero value means the item never expires, equivalent to `insert`.

```rust
pub fn insert_with_ttl(&self, key: K, val: V, cost: i64, ttl: Duration) -> bool
```

--------------------------------

### Is Cache Empty

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

`is_empty` checks if the cache contains any items.

```APIDOC
## pub fn is_empty(&self) -> bool

### Description
Checks whether the cache contains any items.

### Returns
- **bool** - True if the cache is empty, false otherwise.
```

--------------------------------

### Cache::clear

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Clears all entries from the cache. Requires the `sync` feature flag.

```APIDOC
## Cache::clear

### Description
Clears all entries from the cache.

### Method
`clear(&self) -> Result<(), CacheError>`

### Response
* `Result<(), CacheError>` - A `Result` indicating success or a `CacheError`.
```

--------------------------------

### hash_index Method Signature

Source: https://docs.rs/stretto/0.8.4/stretto/trait.KeyBuilder.html

This method is required for all KeyBuilder implementations. It hashes the provided key into a single u64 value.

```rust
fn hash_index<Q>(&self, key: &Q) -> u64
   where Self::Key: Borrow<Q>,
         Q: Hash + Eq + ?Sized;
```

--------------------------------

### Try to insert if key is already present

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

The non-panicking version of `insert_if_present`. Updates the value of an existing key in the cache. Does not add the key if it is absent.

```rust
pub fn try_insert_if_present(
 &self,
 key: K,
 val: V,
 cost: i64,
 ) -> Result<bool, CacheError>
```

--------------------------------

### Insert into AsyncCache

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCache.html

Asynchronously attempts to insert a key-value pair with a specified cost into the cache. Returns true if the insert was successful, false if dropped. The item might still be dropped by the policy if deemed not worth keeping.

```rust
pub async fn insert(&self, key: K, val: V, cost: i64) -> bool
```

--------------------------------

### Insert a key-value item into the Cache

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Attempts to add a key-value item to the cache with a specified cost. Returns `false` if the insert was dropped. If `cost` is 0, the Coster function will be used to determine the item's cost.

```rust
pub fn insert(&self, key: K, val: V, cost: i64) -> bool
```

--------------------------------

### to_u64 Method Implementation for bool

Source: https://docs.rs/stretto/0.8.4/stretto/trait.TransparentKey.html

Converts a boolean value to its u64 representation. This is a default implementation provided for the `TransparentKey` trait.

```rust
fn to_u64(&self) -> u64
```

--------------------------------

### TryInto<U> for T

Source: https://docs.rs/stretto/0.8.4/stretto/enum.MetricType.html

Provides a generic implementation for fallible conversions from type T into type U.

```APIDOC
## TryInto<U> for T

### Description
Provides a generic implementation for fallible conversions from type `T` into type `U`, where `U` implements `TryFrom<T>`.

### Type Alias
`type Error = <U as TryFrom<T>>::Error`

### Signature
`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

### Details
Performs the conversion. Returns `Ok(U)` on success or an error if the conversion fails.
```

--------------------------------

### Cache::insert_with_ttl

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Cache.html

Inserts a key-value pair with a time-to-live (TTL). Requires the `sync` feature flag.

```APIDOC
## Cache::insert_with_ttl

### Description
Works like `insert` but adds a key-value pair that will expire after the specified TTL (time to live) has passed. A zero value means the value never expires, which is identical to calling `insert`.

### Method
`insert_with_ttl(&self, key: K, val: V, cost: i64, ttl: Duration) -> bool`

### Parameters
* `key` (K) - The key to insert.
* `val` (V) - The value to insert.
* `cost` (i64) - The cost of the item. Set to 0 to use the `Coster` function.
* `ttl` (Duration) - The time-to-live for the item.

### Response
* `bool` - `true` if the item was inserted (or has a chance to be kept), `false` if the insert was dropped.
```

--------------------------------

### impl Default for TransparentHasher

Source: https://docs.rs/stretto/0.8.4/stretto/struct.TransparentHasher.html

Provides a default value for TransparentHasher.

```APIDOC
## impl Default for TransparentHasher

### fn default() -> TransparentHasher

Returns the “default value” for a type.
```

--------------------------------

### TransparentKey Trait

Source: https://docs.rs/stretto/0.8.4/stretto/trait.TransparentKey.html

Implement this trait for the key, if you want to use `TransparentKeyBuilder` as the `KeyBuilder` for the `Cache`. Basic integer types and booleans implement this trait by default.

```APIDOC
## Trait TransparentKey

```rust
pub trait TransparentKey: Hash + Eq {
    // Required method
    fn to_u64(&self) -> u64;
}
```

### Required Methods

#### fn to_u64(&self) -> u64

Convert self to `u64`.
```

--------------------------------

### Histogram::new

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Histogram.html

Returns a new instance of HistogramData with properly initialized fields.

```APIDOC
## Histogram::new

### Description
Returns a new instance of HistogramData with properly initialized fields.

### Method
`pub fn new(bounds: Vec<f64>) -> Self`

### Parameters
#### Path Parameters
- **bounds** (Vec<f64>) - Required - The bounds for the histogram, represented as powers of two.

### Response
#### Success Response
- **Self** - A new instance of HistogramData.
```

--------------------------------

### Clone Metrics Instance

Source: https://docs.rs/stretto/0.8.4/stretto/enum.Metrics.html

Returns a duplicate of the current Metrics instance.

```rust
fn clone(&self) -> Metrics
```

--------------------------------

### Set Number of Counters

Source: https://docs.rs/stretto/0.8.4/stretto/struct.AsyncCacheBuilder.html

Configures the number of 4-bit access counters for admission and eviction. A common recommendation is 10x the expected number of items in a full cache.

```rust
builder.set_num_counters(1000);
```

--------------------------------

### clone_from Method

Source: https://docs.rs/stretto/0.8.4/stretto/struct.Item.html

Performs copy-assignment from a source Item to the current one. This method is part of the Clone trait implementation.

```rust
fn clone_from(&mut self, source: &Self)
```
Tokens:
Raw