Struct Pooled

pub struct Pooled<T: Poolable + Send + 'static> { /* private fields */ }

A generic wrapper for pooled objects. This handles keeping track of the pool pointer for you and allows you to wrap almost any container type easily.

Most of the time, this is what you want to use.

Implementations

impl<T: Poolable + Send + 'static> Pooled<T>

pub fn orphan(t: T) -> Self

Creates a Pooled that isn’t connected to any pool. E.G. for branches where you know a given Pooled will always be empty.

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

assign the Pooled to the specified pool. When it is 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 it.

Trait Implementations

impl<T: Poolable + Send + 'static> AsRef<T> for Pooled<T>

fn as_ref(&self) -> &T

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

impl<T: Poolable + Send + 'static> Borrow<T> for Pooled<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl Borrow<str> for Pooled<String>

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T: Clone + Poolable + Send + 'static> Clone for Pooled<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Poolable + Send + 'static> Debug for Pooled<T>

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

Formats the value using the given formatter.

impl<T: Poolable + Send + 'static> Deref for Pooled<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Poolable + Send + 'static> DerefMut for Pooled<T>

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

Mutably dereferences the value.

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

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Poolable + Send + 'static> Drop for Pooled<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Poolable + Send + 'static + Hash> Hash for Pooled<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 + Send + 'static + Ord> Ord for Pooled<T>

fn cmp(&self, other: &Pooled<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: Pack + Any + Send + Sync + Poolable> Pack for Pooled<T>

fn encoded_len(&self) -> usize

fn encode(&self, buf: &mut impl BufMut) -> Result<(), PackError>

fn decode(buf: &mut impl Buf) -> Result<Self, PackError>

fn decode_into(&mut self, buf: &mut impl Buf) -> Result<(), PackError>

fn const_encoded_len() -> Option<usize>

impl<T: Poolable + Send + 'static + PartialEq> PartialEq for Pooled<T>

fn eq(&self, other: &Pooled<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 + Send + 'static + PartialOrd> PartialOrd for Pooled<T>

fn partial_cmp(&self, other: &Pooled<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 + Send + 'static> RawPoolable for Pooled<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 it’s 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 + Send + 'static + Serialize> Serialize for Pooled<T>

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 + Send + 'static + Eq> Eq for Pooled<T>