Struct Mc

pub struct Mc<T>(/* private fields */);

A smart pointer that allows mutation on immutable values.

This uses a *mut T internally, so most internal operations are unsafe. However, thanks to Rust’s borrowing guarantees, many of these operations are safe when used publicly. The only operation that is not safe is as_defiant_mut, which creates a mutable reference in defiance of Rust’s rules.

Implementations

impl<T> Mc<T>

pub fn new(t: T) -> Mc<T>

Creates a new Mc from a value.

Example

use mutable_constant::Mc;
 
let mc = Mc::new(42);

pub unsafe fn as_defiant_mut(&self) -> &mut T

Gets a mutable reference to the inner value.

Safety

This is unsafe because the mutable reference does not obey the borrow checker. For example, a mutable reference to a Mc can be created while there is an immutable reference to the same Mc. If you do not need this specific behavior, use as_mut instead.

Example

use mutable_constant::Mc;
 
let mut mc = Mc::new(42);
 
unsafe {
    *mc.as_defiant_mut() = 43;
}

Trait Implementations

impl<T, R> Add<R> for Mc<T>

where T: Add<R> + Clone,

type Output = <T as Add<R>>::Output

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, R> AddAssign<R> for Mc<T>

where T: AddAssign<R>,

fn add_assign(&mut self, rhs: R)

Performs the += operation.

impl<T> AsMut<T> for Mc<T>

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

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

impl<T> AsRef<T> for Mc<T>

fn as_ref(&self) -> &T

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

impl<T, R> BitAnd<R> for Mc<T>

where T: BitAnd<R> + Clone,

type Output = <T as BitAnd<R>>::Output

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, R> BitAndAssign<R> for Mc<T>

where T: BitAndAssign<R>,

fn bitand_assign(&mut self, rhs: R)

Performs the &= operation.

impl<T, R> BitOr<R> for Mc<T>

where T: BitOr<R> + Clone,

type Output = <T as BitOr<R>>::Output

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, R> BitOrAssign<R> for Mc<T>

where T: BitOrAssign<R>,

fn bitor_assign(&mut self, rhs: R)

Performs the |= operation.

impl<T, R> BitXor<R> for Mc<T>

where T: BitXor<R> + Clone,

type Output = <T as BitXor<R>>::Output

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, R> BitXorAssign<R> for Mc<T>

where T: BitXorAssign<R>,

fn bitxor_assign(&mut self, rhs: R)

Performs the ^= operation.

impl<T> Clone for Mc<T>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Mc<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Mc<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Mc<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for Mc<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T, R> Div<R> for Mc<T>

where T: Div<R> + Clone,

type Output = <T as Div<R>>::Output

The resulting type after applying the / operator.

fn div(self, rhs: R) -> Self::Output

Performs the / operation.

impl<T, R> DivAssign<R> for Mc<T>

where T: DivAssign<R>,

fn div_assign(&mut self, rhs: R)

Performs the /= operation.

impl<T> Drop for Mc<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Hash for Mc<T>

where T: Hash + Clone,

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<T, R> Mul<R> for Mc<T>

where T: Mul<R> + Clone,

type Output = <T as Mul<R>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: R) -> Self::Output

Performs the * operation.

impl<T, R> MulAssign<R> for Mc<T>

where T: MulAssign<R>,

fn mul_assign(&mut self, rhs: R)

Performs the *= operation.

impl<T> Neg for Mc<T>

where T: Neg + Clone,

type Output = <T as Neg>::Output

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T> Not for Mc<T>

where T: Not + Clone,

type Output = <T as Not>::Output

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T> Ord for Mc<T>

where T: Ord + Clone + PartialOrd<Mc<T>>,

fn cmp(&self, other: &Self) -> 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, R> PartialEq<R> for Mc<T>

where T: PartialEq<R> + Clone,

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

Tests for self and other values to be equal, and is used by ==.

const 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, R> PartialOrd<R> for Mc<T>

where T: PartialOrd<R> + Clone,

fn partial_cmp(&self, other: &R) -> 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, R> Rem<R> for Mc<T>

where T: Rem<R> + Clone,

type Output = <T as Rem<R>>::Output

The resulting type after applying the % operator.

fn rem(self, rhs: R) -> Self::Output

Performs the % operation.

impl<T, R> RemAssign<R> for Mc<T>

where T: RemAssign<R>,

fn rem_assign(&mut self, rhs: R)

Performs the %= operation.

impl<T> Shl<usize> for Mc<T>

where T: Shl<usize> + Clone,

type Output = <T as Shl<usize>>::Output

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T> ShlAssign<usize> for Mc<T>

where T: ShlAssign<usize>,

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl<T> Shr<usize> for Mc<T>

where T: Shr<usize> + Clone,

type Output = <T as Shr<usize>>::Output

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T> ShrAssign<usize> for Mc<T>

where T: ShrAssign<usize>,

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl<T, R> Sub<R> for Mc<T>

where T: Sub<R> + Clone,

type Output = <T as Sub<R>>::Output

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, R> SubAssign<R> for Mc<T>

where T: SubAssign<R>,

fn sub_assign(&mut self, rhs: R)

Performs the -= operation.

impl<T> Eq for Mc<T>

where T: Eq + Clone + PartialEq<Mc<T>>,