Struct GPooled 

pub struct GPooled<T: Poolable> { /* private fields */ }

A wrapper for globally pooled objects with cross-thread pool affinity.

GPooled<T> ensures objects always return to their origin pool, regardless of which thread drops them. This is essential for producer-consumer patterns where one thread creates objects and other threads consume them.

When to Use

Use GPooled when:

• One thread primarily creates objects, other threads consume them
• You need objects to return to a specific pool
• You have a producer-consumer pattern across threads

Otherwise, prefer LPooled for better performance.

Example

use poolshark::global::{Pool, GPooled};
use std::sync::LazyLock;

// Shared pool for cross-thread usage
static MESSAGES: LazyLock<Pool<String>> = LazyLock::new(|| Pool::new(1024, 4096));

fn producer() -> GPooled<String> {
    let mut msg = MESSAGES.take();
    msg.push_str("Hello from producer");
    msg  // Can be sent to consumer thread
}

fn consumer(msg: GPooled<String>) {
    println!("{}", msg);
    // Dropped here, returns to MESSAGES pool (not consumer's thread-local pool)
}

Behavior

• Pool affinity: Always returns to the pool it was created from
• Thread-safe: Can be sent between threads
• Overhead: One word (8 bytes on 64-bit) to store pool pointer
• Lock-free: Uses crossbeam lock-free queues

Implementations

impl<T: IsoPoolable> GPooled<T>

pub fn take() -> Self

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

impl<T: Poolable> GPooled<T>

pub fn orphan(t: T) -> Self

Creates a GPooled that isn’t connected to any pool.

Useful for branches where you know a given Pooled will always be empty.

pub fn assign(&mut self, pool: &Pool<T>)

Assign the GPooled to the specified pool.

When dropped, it will be placed in pool instead of the pool it was originally allocated from. If an orphan is assigned a pool it will no longer be orphaned.

pub fn detach(self) -> T

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

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

Trait Implementations

impl<T: Poolable> AsRef<T> for GPooled<T>

fn as_ref(&self) -> &T

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

impl<T: Poolable> Borrow<T> for GPooled<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl Borrow<str> for GPooled<String>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T: Clone + Poolable> Clone for GPooled<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Poolable + Debug> Debug for GPooled<T>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<T: Poolable> Deref for GPooled<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Poolable> DerefMut for GPooled<T>

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

Mutably dereferences the value.

impl<'de, T: Poolable + DeserializeOwned + 'static> Deserialize<'de> for GPooled<T>

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Poolable + Display> Display for GPooled<T>

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

Formats the value using the given formatter.

impl<T: Poolable> Drop for GPooled<T>

fn drop(&mut self)

Executes the destructor for this type.

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

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

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: Poolable + Hash> Hash for GPooled<T>

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: Poolable + Ord> Ord for GPooled<T>

fn cmp(&self, other: &GPooled<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: Poolable + PartialEq> PartialEq for GPooled<T>

fn eq(&self, other: &GPooled<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: Poolable + PartialOrd> PartialOrd for GPooled<T>

fn partial_cmp(&self, other: &GPooled<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: Poolable> RawPoolable for GPooled<T>

fn empty(pool: WeakPool<Self>) -> Self

allocate a new empty object and set it’s pool pointer to pool

fn reset(&mut self)

empty the collection and reset it to its default state so it can be put back in the pool

fn capacity(&self) -> usize

return the capacity of the collection

fn really_drop(self)

Actually drop the inner object, don’t put it back in the pool, make sure you do not call both this method and the drop implementation that puts the object back in the pool!

impl<T: Poolable + Serialize> Serialize for GPooled<T>

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Poolable + Eq> Eq for GPooled<T>