Struct TypeResource

pub struct TypeResource<T: TypeResourced> { /* private fields */ }

A newtype-based ID that associates a resource with its inner ID.

Examples

type_resource![Id1, Id2: u32];
let (id1, id2) = (Id1::new(42), Id2::new(42));

assert_eq!(42, *id1.get());
assert_eq!(*id1.get(), *id2.get());

assert_eq!(id1, id2); // type mismatch compile error

See also: type_resource!, TypeResourced.

Implementations

impl<T: TypeResourced> TypeResource<T>

pub const fn new(data: T::TypeData) -> Self

Creates a new TypeResource instance with the given inner ID.

pub const fn get(&self) -> &T::TypeData

Gets a reference to the ID data.

pub fn take(self) -> T::TypeData

Takes ownership of the ID data.

Trait Implementations

impl<T, const LEN: usize> BitSized<LEN> for TypeResource<T>

where T: TypeResourced, T::TypeData: BitSized<LEN>,

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

impl<T> Clone for TypeResource<T>

where T: TypeResourced, T::TypeData: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ConstDefault for TypeResource<T>

where T: TypeResourced, T::TypeData: ConstDefault,

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl<T> Debug for TypeResource<T>

where T: TypeResourced, T::TypeData: Debug,

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

Formats the value using the given formatter.

impl<T> Default for TypeResource<T>

where T: TypeResourced, T::TypeData: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for TypeResource<T>

where T: TypeResourced, T::TypeData: Display,

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

Formats the value using the given formatter.

impl<'a, T> From<&'a str> for TypeResource<T>

where T: TypeResourced<TypeData = &'a str>,

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<T> From<String> for TypeResource<T>

where T: TypeResourced<TypeData = String>,

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> From<bool> for TypeResource<T>

where T: TypeResourced<TypeData = bool>,

fn from(value: bool) -> Self

Converts to this type from the input type.

impl<T> From<char> for TypeResource<T>

where T: TypeResourced<TypeData = char>,

fn from(value: char) -> Self

Converts to this type from the input type.

impl<T> From<i128> for TypeResource<T>

where T: TypeResourced<TypeData = i128>,

fn from(value: i128) -> Self

Converts to this type from the input type.

impl<T> From<i16> for TypeResource<T>

where T: TypeResourced<TypeData = i16>,

fn from(value: i16) -> Self

Converts to this type from the input type.

impl<T> From<i32> for TypeResource<T>

where T: TypeResourced<TypeData = i32>,

fn from(value: i32) -> Self

Converts to this type from the input type.

impl<T> From<i64> for TypeResource<T>

where T: TypeResourced<TypeData = i64>,

fn from(value: i64) -> Self

Converts to this type from the input type.

impl<T> From<i8> for TypeResource<T>

where T: TypeResourced<TypeData = i8>,

fn from(value: i8) -> Self

Converts to this type from the input type.

impl<T> From<isize> for TypeResource<T>

where T: TypeResourced<TypeData = isize>,

fn from(value: isize) -> Self

Converts to this type from the input type.

impl<T> From<u128> for TypeResource<T>

where T: TypeResourced<TypeData = u128>,

fn from(value: u128) -> Self

Converts to this type from the input type.

impl<T> From<u16> for TypeResource<T>

where T: TypeResourced<TypeData = u16>,

fn from(value: u16) -> Self

Converts to this type from the input type.

impl<T> From<u32> for TypeResource<T>

where T: TypeResourced<TypeData = u32>,

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<T> From<u64> for TypeResource<T>

where T: TypeResourced<TypeData = u64>,

fn from(value: u64) -> Self

Converts to this type from the input type.

impl<T> From<u8> for TypeResource<T>

where T: TypeResourced<TypeData = u8>,

fn from(value: u8) -> Self

Converts to this type from the input type.

impl<T> From<usize> for TypeResource<T>

where T: TypeResourced<TypeData = usize>,

fn from(value: usize) -> Self

Converts to this type from the input type.

impl<T> Hash for TypeResource<T>

where T: TypeResourced, T::TypeData: 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for TypeResource<T>

where T: TypeResourced, T::TypeData: Ord,

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> PartialEq for TypeResource<T>

where T: TypeResourced, T::TypeData: PartialEq,

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

where T: TypeResourced, T::TypeData: 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

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> Copy for TypeResource<T>

where T: TypeResourced, T::TypeData: Copy,

impl<T> Eq for TypeResource<T>

where T: TypeResourced, T::TypeData: Eq,