Struct shredder::DerefGc

pub struct DerefGc<T: Scan + GcDeref + ?Sized> { /* fields omitted */ }

A Gc, but with the ability to Deref to its contents!

This comes with the requirement that your data implement GcDeref, which can be limiting. See GcDeref documentation for details.

Implementations

impl<T: Scan + GcDeref + ?Sized> DerefGc<T>

pub fn new(v: T) -> Self where
    T: Sized + GcDrop, 

Create a new DerefGc containing the given data. T: GcDrop in order to create a Gc<T> with this method. If your T is not GcDrop, consider new_with_finalizer.

When this data is garbage collected, its drop implementation will be run.

It is possible for this data not to be collected before the program terminates, or for the program to terminate before the background thread runs its destructor. So be careful when relying on this guarantee.

pub fn new_no_drop(v: T) -> Self where
    T: Sized, 

Create a new DerefGc containing the given data. (But specifying not to run its destructor.) This is useful because T: GcDrop is no longer necessary!

When this data is garbage collected, its drop implementation will NOT be run. Be careful using this method! It can lead to memory leaks!

pub fn new_with_finalizer(v: T) -> Self where
    T: Sized + Finalize, 

Create a new DerefGc containing the given data. (But specifying to call finalize on it instead of running its destructor.) This is useful because T: GcDrop is no longer necessary!

As long as finalize does what you think it does, this is probably what you want for non-'static/non-GcDrop data!

It is possible for this data not to be collected before the program terminates, or for the program to terminate before the background thread runs finalize. So be careful!

pub fn from_box(v: Box<T>) -> Self where
    T: ToScan + GcDrop, 

Create a new DerefGc using the given Box<T>.

This function does not allocate anything - rather, it uses the Box<T> and releases its memory appropriately. This is useful since it removes the requirement for types to be sized.

impl<T: Scan + GcDeref + ?Sized> DerefGc<T>

pub fn downcast<S>(&self) -> Option<DerefGc<S>> where
    T: Any + 'static,
    S: Scan + GcDeref + Any + 'static, 

Attempt to downcast this DerefGc<T> to a DerefGc<S>

For implementation reasons this returns a new DerefGc<T> on success On failure (if there was not an S in the DerefGc<T>) then None is returned

Trait Implementations

impl<T: Scan + GcDeref + ?Sized> Clone for DerefGc<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Scan + GcDeref + ?Sized> Debug for DerefGc<T>

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

Formats the value using the given formatter.

impl<T: Scan + GcDeref + ?Sized> Default for DerefGc<T> where
    T: Default + GcDrop, 

fn default() -> Self

Returns the “default value” for a type.

impl<T: Scan + GcDeref + ?Sized> Deref for DerefGc<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Scan + GcDeref + ?Sized> Display for DerefGc<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: Scan + GcDeref + ?Sized> Drop for DerefGc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Scan + GcDeref + ?Sized> Finalize for DerefGc<T>

unsafe fn finalize(&mut self)

Do cleanup on this data, potentially leaving it in an invalid state. (See trait documentation for the rules for implementing this method.)

impl<T: Scan + GcDeref + ?Sized> Hash for DerefGc<T> where
    T: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: Scan + GcDeref + ?Sized> Ord for DerefGc<T> where
    T: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T: Scan + GcDeref + ?Sized> PartialEq<DerefGc<T>> for DerefGc<T> where
    T: PartialEq, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T: Scan + GcDeref + ?Sized> PartialOrd<DerefGc<T>> for DerefGc<T> where
    T: PartialOrd, 

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: Scan + GcDeref + ?Sized> Pointer for DerefGc<T>

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

Formats the value using the given formatter.

impl<T: Scan + GcDeref + ?Sized> Scan for DerefGc<T>

fn scan(&self, scanner: &mut Scanner<'_>)

scan should use the scanner to scan all of its directly owned data

impl<T: Scan + GcDeref + ?Sized> Eq for DerefGc<T> where
    T: Eq, 

impl<T: Scan + GcDeref + Send + Sync + ?Sized> GcDeref for DerefGc<T>

impl<T: Scan + GcDeref + ?Sized> GcSafe for DerefGc<T>

impl<T: Scan + GcDeref + ?Sized> Send for DerefGc<T> where
    T: Sync + Send, 

impl<T: Scan + GcDeref + ?Sized> Sync for DerefGc<T> where
    T: Sync + Send,