Struct LPooled 

pub struct LPooled<T>(/* private fields */)
where
    T: IsoPoolable;

A zero-cost wrapper for thread-local pooled objects.

LPooled<T> automatically returns objects to the thread-local pool when dropped. This is the recommended default for most use cases as it’s faster than GPooled.

When to Use

• Default choice for pooling
• Objects created and dropped on the same thread
• Maximum performance is important

For producer-consumer patterns where one thread creates and other threads consume, use GPooled instead.

Example

use poolshark::local::LPooled;
use std::collections::HashMap;

fn process_request(data: &[(&str, i32)]) -> LPooled<HashMap<String, i32>> {
    // will reuse dropped HashMaps
    let mut map: LPooled<HashMap<String, i32>> = LPooled::take();
    for (k, v) in data {
        map.insert(k.to_string(), *v);
    }
    map
}

Behavior

• Minimal overhead: Same size as T on the stack, with thread-local lookup cost on drop and take
• Thread-safe: Can be sent between threads (implements Send + Sync if T does)
• Drop behavior: Returns to the pool of whichever thread drops it
• Automatic: No manual pool management required

Implementations

impl<T> LPooled<T>

where T: IsoPoolable,

pub fn take() -> LPooled<T>

Take an object from the pool, or create one if the pool is empty.

This is the same as Default::default.

pub fn take_sz(max: usize, max_elements: usize) -> LPooled<T>

Take an object from the pool with custom pool sizes.

Creates a new object if the pool is empty. Configures the pool sizes if not already set.

pub fn detach(self) -> T

Detach the object from the pool, returning the inner value.

The detached object will not be returned to the pool when dropped.

Trait Implementations

impl<T> AsRef<T> for LPooled<T>

where T: IsoPoolable,

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Borrow<T> for LPooled<T>

where T: IsoPoolable,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl Borrow<str> for LPooled<String>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T> Clone for LPooled<T>

where T: Clone + IsoPoolable,

fn clone(&self) -> LPooled<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for LPooled<T>

where T: Debug + IsoPoolable,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Default for LPooled<T>

where T: IsoPoolable,

fn default() -> LPooled<T>

Returns the “default value” for a type.

impl<T> Deref for LPooled<T>

where T: IsoPoolable,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> DerefMut for LPooled<T>

where T: IsoPoolable,

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for LPooled<T>

where T: IsoPoolable + DeserializeOwned + 'static,

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<LPooled<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for LPooled<T>

where T: IsoPoolable + Display,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Drop for LPooled<T>

where T: IsoPoolable,

fn drop(&mut self)

Executes the destructor for this type.

impl<T, E> Extend<E> for LPooled<T>

where T: IsoPoolable + Extend<E>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = E>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> From<T> for LPooled<T>

where T: IsoPoolable,

fn from(t: T) -> LPooled<T>

Converts to this type from the input type.

impl<T, E> FromIterator<E> for LPooled<T>

where T: IsoPoolable + Extend<E>,

fn from_iter<I>(iter: I) -> LPooled<T>

where I: IntoIterator<Item = E>,

Creates a value from an iterator.

impl<T> FromValue for LPooled<Vec<T>>

where T: FromValue + Send + Sync + 'static,

fn from_value(v: Value) -> Result<LPooled<Vec<T>>, Error>

attempt to cast v to the type of self using any reasonable means

fn get(v: Value) -> Option<LPooled<Vec<T>>>

extract the type of self from v if the type of v is equivelent to the type of self, otherwise return None.

impl<T> Hash for LPooled<T>

where T: Hash + IsoPoolable,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for LPooled<T>

where T: Ord + IsoPoolable,

fn cmp(&self, other: &LPooled<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for LPooled<T>

where T: PartialEq + IsoPoolable,

fn eq(&self, other: &LPooled<T>) -> 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.

impl<T> PartialOrd for LPooled<T>

where T: PartialOrd + IsoPoolable,

fn partial_cmp(&self, other: &LPooled<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for LPooled<T>

where T: IsoPoolable + Serialize,

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Eq for LPooled<T>

where T: Eq + IsoPoolable,

impl<T> StructuralPartialEq for LPooled<T>

where T: IsoPoolable,