Struct new_units::Unit

#[repr(transparent)]
pub struct Unit<T, Marker>(pub T, _);

Add a marker to another type, eg Unit<Point3, LastPosition>.

Units try to be as transparent as possible: they deref to T, and the various operators forward to it.

Tuple Fields

0: T

Implementations

impl<T, M> Unit<T, M>

pub fn map<R>(self, f: impl FnOnce(T) -> R) -> Unit<R, M>

Change the contained value. Note that Unit also implements Deref, DerefMut, etc; or you can use self.0.

pub fn with_unit<N>(self, _n: N) -> Unit<T, N>

Change the unit.

Example

use new_units::*;
struct Position;
struct LastPosition;
let position = (0, 0).of(Position);
// (And then some stuff happens...)
let previous_position = position.with_unit(LastPosition);

impl<T> Unit<T, ()>

pub const fn new<M>(t: T) -> Unit<T, M>

pub const fn index<M>(t: T) -> Unit<T, [M; 0]>

Constructs an index. You can use this to prevent using an index on the wrong value.

See OfUnit::over for a more pleasant API.

Example

let data1 = vec![0];
struct Marked;
let data2 = Unit::new::<Marked>(data1.clone());
assert_eq!(
    data1[0],
    data2[Unit::index::<Marked>(0usize)],
);

impl<M> Unit<usize, M>

pub fn shrink<U: IntoIndex>(self) -> Unit<U, M>

Reduce the size. Panics if too large.

See Also

IntoIndex

Trait Implementations

impl<T, M> Add<T> for Unit<T, M>where T: Add<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, M> Add<Unit<T, M>> for Unit<T, M>where T: Add<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, M> AddAssign<T> for Unit<T, M>where T: AddAssign,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T, M> AddAssign<Unit<T, M>> for Unit<T, M>where T: AddAssign,

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T, M> BitAnd<T> for Unit<T, M>where T: BitAnd<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, M> BitAnd<Unit<T, M>> for Unit<T, M>where T: BitAnd<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, M> BitAndAssign<T> for Unit<T, M>where T: BitAndAssign,

fn bitand_assign(&mut self, rhs: T)

Performs the &= operation.

impl<T, M> BitAndAssign<Unit<T, M>> for Unit<T, M>where T: BitAndAssign,

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<T, M> BitOr<T> for Unit<T, M>where T: BitOr<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, M> BitOr<Unit<T, M>> for Unit<T, M>where T: BitOr<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, M> BitOrAssign<T> for Unit<T, M>where T: BitOrAssign,

fn bitor_assign(&mut self, rhs: T)

Performs the |= operation.

impl<T, M> BitOrAssign<Unit<T, M>> for Unit<T, M>where T: BitOrAssign,

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<T, M> BitXor<T> for Unit<T, M>where T: BitXor<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, M> BitXor<Unit<T, M>> for Unit<T, M>where T: BitXor<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, M> BitXorAssign<T> for Unit<T, M>where T: BitXorAssign,

fn bitxor_assign(&mut self, rhs: T)

Performs the ^= operation.

impl<T, M> BitXorAssign<Unit<T, M>> for Unit<T, M>where T: BitXorAssign,

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<T: Clone, M> Clone for Unit<T, M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, M> Debug for Unit<T, M>

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

Formats the value using the given formatter.

impl<T: Default, M> Default for Unit<T, M>

fn default() -> Self

Returns the “default value” for a type.

impl<T, M> Deref for Unit<T, M>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, M> DerefMut for Unit<T, M>

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

Mutably dereferences the value.

impl<T, M> Div<T> for Unit<T, M>where T: Div<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, M> Div<Unit<T, M>> for Unit<T, M>where T: Div<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T, M> DivAssign<T> for Unit<T, M>where T: DivAssign,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T, M> DivAssign<Unit<T, M>> for Unit<T, M>where T: DivAssign,

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl<T, Marker> From<T> for Unit<T, Marker>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T: Hash, M> Hash for Unit<T, M>

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, M, I> Index<Unit<I, [M; 0]>> for Unit<T, M>where T: Index<usize>, I: IntoIndex,

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

The returned type after indexing.

fn index(&self, index: Unit<I, [M; 0]>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, M, I> IndexMut<Unit<I, [M; 0]>> for Unit<T, M>where T: IndexMut<usize>, I: IntoIndex,

fn index_mut(&mut self, index: Unit<I, [M; 0]>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T, M> Mul<T> for Unit<T, M>where T: Mul<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, M> Mul<Unit<T, M>> for Unit<T, M>where T: Mul<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, M> MulAssign<T> for Unit<T, M>where T: MulAssign,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T, M> MulAssign<Unit<T, M>> for Unit<T, M>where T: MulAssign,

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<T, M> PartialEq<T> for Unit<T, M>where T: PartialEq,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, M> PartialEq<Unit<T, M>> for Unit<T, M>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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, M> PartialOrd<T> for Unit<T, M>where T: PartialOrd,

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

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

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

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

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

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

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

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

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

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

impl<T, M> PartialOrd<Unit<T, M>> for Unit<T, M>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: &Rhs) -> bool

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

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

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

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

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

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

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

impl<T, M> Rem<T> for Unit<T, M>where T: Rem<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, M> Rem<Unit<T, M>> for Unit<T, M>where T: Rem<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the % operator.

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

Performs the % operation.

impl<T, M> RemAssign<T> for Unit<T, M>where T: RemAssign,

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T, M> RemAssign<Unit<T, M>> for Unit<T, M>where T: RemAssign,

fn rem_assign(&mut self, rhs: Self)

Performs the %= operation.

impl<T, M> Shl<T> for Unit<T, M>where T: Shl<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T, M> Shl<Unit<T, M>> for Unit<T, M>where T: Shl<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the << operator.

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

Performs the << operation.

impl<T, M> ShlAssign<T> for Unit<T, M>where T: ShlAssign,

fn shl_assign(&mut self, rhs: T)

Performs the <<= operation.

impl<T, M> ShlAssign<Unit<T, M>> for Unit<T, M>where T: ShlAssign,

fn shl_assign(&mut self, rhs: Self)

Performs the <<= operation.

impl<T, M> Shr<T> for Unit<T, M>where T: Shr<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T, M> Shr<Unit<T, M>> for Unit<T, M>where T: Shr<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl<T, M> ShrAssign<T> for Unit<T, M>where T: ShrAssign,

fn shr_assign(&mut self, rhs: T)

Performs the >>= operation.

impl<T, M> ShrAssign<Unit<T, M>> for Unit<T, M>where T: ShrAssign,

fn shr_assign(&mut self, rhs: Self)

Performs the >>= operation.

impl<T, M> Sub<T> for Unit<T, M>where T: Sub<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, M> Sub<Unit<T, M>> for Unit<T, M>where T: Sub<T, Output = T>,

type Output = Unit<T, M>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, M> SubAssign<T> for Unit<T, M>where T: SubAssign,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T, M> SubAssign<Unit<T, M>> for Unit<T, M>where T: SubAssign,

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<T: Copy, M> Copy for Unit<T, M>

impl<T: Eq, M> Eq for Unit<T, M>