Skip to main content

LPooled

Struct LPooled 

Source
pub struct LPooled<T: IsoPoolable>(/* private fields */);
Expand description

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§

Source§

impl<T: IsoPoolable> LPooled<T>

Source

pub fn take() -> Self

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

This is the same as Default::default.

Source

pub fn take_sz(max: usize, max_elements: usize) -> Self

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.

Source

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§

Source§

impl<T: IsoPoolable> AsRef<T> for LPooled<T>

Source§

fn as_ref(&self) -> &T

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

impl<T: IsoPoolable> Borrow<T> for LPooled<T>

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl Borrow<str> for LPooled<String>

Source§

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more
Source§

impl<T: Clone + IsoPoolable> Clone for LPooled<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + IsoPoolable> Debug for LPooled<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: IsoPoolable> Default for LPooled<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: IsoPoolable> Deref for LPooled<T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.
Source§

impl<T: IsoPoolable> DerefMut for LPooled<T>

Source§

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

Mutably dereferences the value.
Source§

impl<'de, T: IsoPoolable + DeserializeOwned + 'static> Deserialize<'de> for LPooled<T>

Available on crate feature serde only.
Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: IsoPoolable + Display> Display for LPooled<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: IsoPoolable> Drop for LPooled<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T: IsoPoolable + Extend<E>, E> Extend<E> for LPooled<T>

Source§

fn extend<I: IntoIterator<Item = E>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

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. Read more
Source§

impl<T: IsoPoolable> From<T> for LPooled<T>

Source§

fn from(t: T) -> Self

Converts to this type from the input type.
Source§

impl<T: IsoPoolable + Extend<E>, E> FromIterator<E> for LPooled<T>

Source§

fn from_iter<I: IntoIterator<Item = E>>(iter: I) -> Self

Creates a value from an iterator. Read more
Source§

impl<T: Hash + IsoPoolable> Hash for LPooled<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: Ord + IsoPoolable> Ord for LPooled<T>

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq + IsoPoolable> PartialEq for LPooled<T>

Source§

fn eq(&self, other: &LPooled<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T: PartialOrd + IsoPoolable> PartialOrd for LPooled<T>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl<T: IsoPoolable + Serialize> Serialize for LPooled<T>

Available on crate feature serde only.
Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Eq + IsoPoolable> Eq for LPooled<T>

Source§

impl<T: IsoPoolable> StructuralPartialEq for LPooled<T>

Auto Trait Implementations§

§

impl<T> Freeze for LPooled<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for LPooled<T>
where T: RefUnwindSafe,

§

impl<T> Send for LPooled<T>
where T: Send,

§

impl<T> Sync for LPooled<T>
where T: Sync,

§

impl<T> Unpin for LPooled<T>
where T: Unpin,

§

impl<T> UnwindSafe for LPooled<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,