Struct Tag 

pub struct Tag(/* private fields */);

Represents a generation tag used for ABA protection in AtomicTaggedPtr.

Tag wraps a platform-specific generation count and ensures that any operations (like wrapping addition or creation) respect the hardware platform’s limits and bit-width.

Implementations

impl Tag

pub const fn new(value: usize) -> Self

Creates a new Tag from a raw value, applying the platform-specific mask.

pub const fn value(self) -> usize

Gets the raw tag value.

pub const fn wrapping_add(self, rhs: usize) -> Self

Performs wrapping addition on the tag value.

pub const fn wrapping_sub(self, rhs: usize) -> Self

Performs wrapping subtraction on the tag value.

pub const fn next(self) -> Self

Returns the next tag value, wrapping around on overflow.

pub const fn max_value() -> Self

Returns the maximum tag value allowed on this platform.

Trait Implementations

impl Add<usize> for Tag

type Output = Tag

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign<usize> for Tag

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl<T> AsRef<Tag> for TaggedPtr<T>

fn as_ref(&self) -> &Tag

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

impl BitAnd<usize> for Tag

type Output = Tag

The resulting type after applying the & operator.

fn bitand(self, rhs: usize) -> Self::Output

Performs the & operation.

impl BitAnd for Tag

type Output = Tag

The resulting type after applying the & operator.

fn bitand(self, rhs: Tag) -> Self::Output

Performs the & operation.

impl BitAndAssign<usize> for Tag

fn bitand_assign(&mut self, rhs: usize)

Performs the &= operation.

impl BitAndAssign for Tag

fn bitand_assign(&mut self, rhs: Tag)

Performs the &= operation.

impl BitOr<usize> for Tag

type Output = Tag

The resulting type after applying the | operator.

fn bitor(self, rhs: usize) -> Self::Output

Performs the | operation.

impl BitOr for Tag

type Output = Tag

The resulting type after applying the | operator.

fn bitor(self, rhs: Tag) -> Self::Output

Performs the | operation.

impl BitOrAssign<usize> for Tag

fn bitor_assign(&mut self, rhs: usize)

Performs the |= operation.

impl BitOrAssign for Tag

fn bitor_assign(&mut self, rhs: Tag)

Performs the |= operation.

impl BitXor<usize> for Tag

type Output = Tag

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: usize) -> Self::Output

Performs the ^ operation.

impl BitXor for Tag

type Output = Tag

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Tag) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<usize> for Tag

fn bitxor_assign(&mut self, rhs: usize)

Performs the ^= operation.

impl BitXorAssign for Tag

fn bitxor_assign(&mut self, rhs: Tag)

Performs the ^= operation.

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Default for Tag

fn default() -> Tag

Returns the “default value” for a type.

impl Display for Tag

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

Formats the value using the given formatter.

impl From<Tag> for usize

fn from(tag: Tag) -> usize

Converts to this type from the input type.

impl From<u16> for Tag

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Tag

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u8> for Tag

fn from(value: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Tag

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for Tag

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for Tag

type Output = Tag

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Tag

fn cmp(&self, other: &Tag) -> 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 PartialEq for Tag

fn eq(&self, other: &Tag) -> 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 PartialOrd for Tag

fn partial_cmp(&self, other: &Tag) -> 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 Sub<usize> for Tag

type Output = Tag

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl SubAssign<usize> for Tag

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl Copy for Tag

impl Eq for Tag

impl StructuralPartialEq for Tag