pub struct Sticky<T: 'static> { /* private fields */ }
Expand description

A Sticky<T> keeps a value T stored in a thread.

This type works similar in nature to Fragile and exposes a similar interface. The difference is that whereas Fragile has its destructor called in the thread where the value was sent, a Sticky that is moved to another thread will have the internal destructor called when the originating thread tears down.

Because Sticky allows values to be kept alive for longer than the Sticky itself, it requires all its contents to be 'static for soundness. More importantly it also requires the use of StackTokens. For information about how to use stack tokens and why they are neded, refer to stack_token!.

As this uses TLS internally the general rules about the platform limitations of destructors for TLS apply.

Implementations

Creates a new Sticky wrapping a value.

The value that is moved into the Sticky can be non Send and will be anchored to the thread that created the object. If the sticky wrapper type ends up being send from thread to thread only the original thread can interact with the value.

Returns true if the access is valid.

This will be false if the value was sent to another thread.

Consumes the Sticky, returning the wrapped value.

Panics

Panics if called from a different thread than the one where the original value was created.

Consumes the Sticky, returning the wrapped value if successful.

The wrapped value is returned if this is called from the same thread as the one where the original value was created, otherwise the Sticky is returned as Err(self).

Immutably borrows the wrapped value.

Panics

Panics if the calling thread is not the one that wrapped the value. For a non-panicking variant, use try_get.

Mutably borrows the wrapped value.

Panics

Panics if the calling thread is not the one that wrapped the value. For a non-panicking variant, use try_get_mut.

Tries to immutably borrow the wrapped value.

Returns None if the calling thread is not the one that wrapped the value.

Tries to mutably borrow the wrapped value.

Returns None if the calling thread is not the one that wrapped the value.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Formats the value using the given formatter. Read more
Executes the destructor for this type. Read more
Converts to this type from the input type.
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Converts to this type from the input type.

Returns the argument unchanged.

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.