Struct gut::Index

#[repr(transparent)]
pub struct Index(_);

A possibly invalid unsigned index. The maximum usize integer represents an invalid index. This index type is ideal for storage. Overflow is not handled by this type. Instead we rely on Rust’s internal overflow panics during debug builds.

Implementations

impl Index

pub const INVALID: Index

Invalid index instance.

pub fn new(i: usize) -> Index

Create a valid index from a usize type. This constructor does the necessary check for debug builds only.

pub fn into_option(self) -> Option<usize>

Convert this Index into Option<usize>, which is a larger struct.

pub fn map_inner<F>(self, f: F) -> Index where
    F: FnOnce(usize) -> usize, 

Manipulate the inner representation of the index. This method avoids the additional check used in map. Use this to opt out of automatic index checking.

pub fn and_then<F>(self, f: F) -> Index where
    F: FnOnce(usize) -> Index, 

Checked and_then over inner index. This allows operations on valid indices only.

pub fn apply<F>(&mut self, f: F) where
    F: FnOnce(&mut usize), 

Apply a function to the inner usize index. The index remains unchanged if invalid.

pub fn if_valid<F>(self, f: F) where
    F: FnOnce(usize), 

Apply a function to the inner usize index.

pub fn into_inner(self) -> usize

Get the raw usize representation of this Index. This may be useful for performance critical code or debugging.

Trait Implementations

impl Add<Index> for Index

type Output = Index

The resulting type after applying the + operator.

pub fn add(self, rhs: Index) -> Index

Performs the + operation.

impl Add<usize> for Index

type Output = Index

The resulting type after applying the + operator.

pub fn add(self, rhs: usize) -> Index

Performs the + operation.

impl AddAssign<usize> for Index

pub fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl CheckedIndex<usize> for Index

pub fn invalid() -> Index

Construct an invalid index.

pub fn is_valid(&self) -> bool

Check if the index is valid.

pub fn unwrap(self) -> usize

Convert the index into its underlying integer type. Panic if index is invalid.

pub fn expect(self, msg: &str) -> usize

Convert the index into its underlying integer type. In case of failure, report the given message.

pub fn map<F>(self, f: F) -> Index where
    F: FnOnce(usize) -> usize, 

Map the underlying integer type. This allows restricting operations to valid indices only.

pub fn map_or<U, F>(self, default: U, f: F) -> U where
    F: FnOnce(usize) -> U, 

Map the underlying integer type. If the index is invalid, output the provided default.

pub fn into_inner(self) -> usize

Produce the raw inner type without checking.

impl Clone for Index

pub fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

pub fn default() -> Index

Returns the “default value” for a type.

impl Display for Index

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

Formats the value using the given formatter.

impl Div<usize> for Index

type Output = Index

The resulting type after applying the / operator.

pub fn div(self, rhs: usize) -> Index

Performs the / operation.

impl From<CellEdgeIndex> for Index

pub fn from(i: CellEdgeIndex) -> Index

Performs the conversion.

impl From<CellFaceIndex> for Index

pub fn from(i: CellFaceIndex) -> Index

Performs the conversion.

impl From<CellIndex> for Index

pub fn from(i: CellIndex) -> Index

Performs the conversion.

impl From<CellVertexIndex> for Index

pub fn from(i: CellVertexIndex) -> Index

Performs the conversion.

impl From<EdgeCellIndex> for Index

pub fn from(i: EdgeCellIndex) -> Index

Performs the conversion.

impl From<EdgeFaceIndex> for Index

pub fn from(i: EdgeFaceIndex) -> Index

Performs the conversion.

impl From<EdgeIndex> for Index

pub fn from(i: EdgeIndex) -> Index

Performs the conversion.

impl From<EdgeVertexIndex> for Index

pub fn from(i: EdgeVertexIndex) -> Index

Performs the conversion.

impl From<FaceCellIndex> for Index

pub fn from(i: FaceCellIndex) -> Index

Performs the conversion.

impl From<FaceEdgeIndex> for Index

pub fn from(i: FaceEdgeIndex) -> Index

Performs the conversion.

impl From<FaceIndex> for Index

pub fn from(i: FaceIndex) -> Index

Performs the conversion.

impl From<FaceVertexIndex> for Index

pub fn from(i: FaceVertexIndex) -> Index

Performs the conversion.

impl From<Index> for EdgeVertexIndex

pub fn from(i: Index) -> EdgeVertexIndex

Performs the conversion.

impl From<Index> for FaceVertexIndex

pub fn from(i: Index) -> FaceVertexIndex

Performs the conversion.

impl From<Index> for CellFaceIndex

pub fn from(i: Index) -> CellFaceIndex

Performs the conversion.

impl From<Index> for FaceIndex

pub fn from(i: Index) -> FaceIndex

Performs the conversion.

impl From<Index> for MeshIndex

pub fn from(i: Index) -> MeshIndex

Performs the conversion.

impl From<Index> for CellEdgeIndex

pub fn from(i: Index) -> CellEdgeIndex

Performs the conversion.

impl From<Index> for EdgeFaceIndex

pub fn from(i: Index) -> EdgeFaceIndex

Performs the conversion.

impl From<Index> for EdgeCellIndex

pub fn from(i: Index) -> EdgeCellIndex

Performs the conversion.

impl From<Index> for EdgeIndex

pub fn from(i: Index) -> EdgeIndex

Performs the conversion.

impl From<Index> for VertexEdgeIndex

pub fn from(i: Index) -> VertexEdgeIndex

Performs the conversion.

impl From<Index> for FaceEdgeIndex

pub fn from(i: Index) -> FaceEdgeIndex

Performs the conversion.

impl From<Index> for VertexFaceIndex

pub fn from(i: Index) -> VertexFaceIndex

Performs the conversion.

impl From<Index> for CellIndex

pub fn from(i: Index) -> CellIndex

Performs the conversion.

impl From<Index> for VertexCellIndex

pub fn from(i: Index) -> VertexCellIndex

Performs the conversion.

impl From<Index> for FaceCellIndex

pub fn from(i: Index) -> FaceCellIndex

Performs the conversion.

impl From<Index> for CellVertexIndex

pub fn from(i: Index) -> CellVertexIndex

Performs the conversion.

impl From<Index> for VertexIndex

pub fn from(i: Index) -> VertexIndex

Performs the conversion.

impl From<MeshIndex> for Index

pub fn from(i: MeshIndex) -> Index

Performs the conversion.

impl From<Option<CellEdgeIndex>> for Index

pub fn from(mb_i: Option<CellEdgeIndex>) -> Index

Performs the conversion.

impl From<Option<CellFaceIndex>> for Index

pub fn from(mb_i: Option<CellFaceIndex>) -> Index

Performs the conversion.

impl From<Option<CellIndex>> for Index

pub fn from(mb_i: Option<CellIndex>) -> Index

Performs the conversion.

impl From<Option<CellVertexIndex>> for Index

pub fn from(mb_i: Option<CellVertexIndex>) -> Index

Performs the conversion.

impl From<Option<EdgeCellIndex>> for Index

pub fn from(mb_i: Option<EdgeCellIndex>) -> Index

Performs the conversion.

impl From<Option<EdgeFaceIndex>> for Index

pub fn from(mb_i: Option<EdgeFaceIndex>) -> Index

Performs the conversion.

impl From<Option<EdgeIndex>> for Index

pub fn from(mb_i: Option<EdgeIndex>) -> Index

Performs the conversion.

impl From<Option<EdgeVertexIndex>> for Index

pub fn from(mb_i: Option<EdgeVertexIndex>) -> Index

Performs the conversion.

impl From<Option<FaceCellIndex>> for Index

pub fn from(mb_i: Option<FaceCellIndex>) -> Index

Performs the conversion.

impl From<Option<FaceEdgeIndex>> for Index

pub fn from(mb_i: Option<FaceEdgeIndex>) -> Index

Performs the conversion.

impl From<Option<FaceIndex>> for Index

pub fn from(mb_i: Option<FaceIndex>) -> Index

Performs the conversion.

impl From<Option<FaceVertexIndex>> for Index

pub fn from(mb_i: Option<FaceVertexIndex>) -> Index

Performs the conversion.

impl From<Option<MeshIndex>> for Index

pub fn from(mb_i: Option<MeshIndex>) -> Index

Performs the conversion.

impl From<Option<VertexCellIndex>> for Index

pub fn from(mb_i: Option<VertexCellIndex>) -> Index

Performs the conversion.

impl From<Option<VertexEdgeIndex>> for Index

pub fn from(mb_i: Option<VertexEdgeIndex>) -> Index

Performs the conversion.

impl From<Option<VertexFaceIndex>> for Index

pub fn from(mb_i: Option<VertexFaceIndex>) -> Index

Performs the conversion.

impl From<Option<VertexIndex>> for Index

pub fn from(mb_i: Option<VertexIndex>) -> Index

Performs the conversion.

impl From<Option<usize>> for Index

pub fn from(i: Option<usize>) -> Index

Performs the conversion.

impl From<VertexCellIndex> for Index

pub fn from(i: VertexCellIndex) -> Index

Performs the conversion.

impl From<VertexEdgeIndex> for Index

pub fn from(i: VertexEdgeIndex) -> Index

Performs the conversion.

impl From<VertexFaceIndex> for Index

pub fn from(i: VertexFaceIndex) -> Index

Performs the conversion.

impl From<VertexIndex> for Index

pub fn from(i: VertexIndex) -> Index

Performs the conversion.

impl From<i16> for Index

Create an index from a signed integer type. If the given argument is negative, the created index will be invalid.

pub fn from(i: i16) -> Index

Performs the conversion.

impl From<i32> for Index

Create an index from a signed integer type. If the given argument is negative, the created index will be invalid.

pub fn from(i: i32) -> Index

Performs the conversion.

impl From<i64> for Index

Create an index from a signed integer type. If the given argument is negative, the created index will be invalid.

pub fn from(i: i64) -> Index

Performs the conversion.

impl From<i8> for Index

Create an index from a signed integer type. If the given argument is negative, the created index will be invalid.

pub fn from(i: i8) -> Index

Performs the conversion.

impl From<isize> for Index

Create an index from a signed integer type. If the given argument is negative, the created index will be invalid.

pub fn from(i: isize) -> Index

Performs the conversion.

impl From<u16> for Index

Create a valid index from a usize type. This converter does the necessary bounds check for debug builds only.

pub fn from(i: u16) -> Index

Performs the conversion.

impl From<u32> for Index

Create a valid index from a usize type. This converter does the necessary bounds check for debug builds only.

pub fn from(i: u32) -> Index

Performs the conversion.

impl From<u64> for Index

Create a valid index from a usize type. This converter does the necessary bounds check for debug builds only.

pub fn from(i: u64) -> Index

Performs the conversion.

impl From<u8> for Index

Create a valid index from a usize type. This converter does the necessary bounds check for debug builds only.

pub fn from(i: u8) -> Index

Performs the conversion.

impl From<usize> for Index

Create a valid index from a usize type. This converter does the necessary bounds check for debug builds only.

pub fn from(i: usize) -> Index

Performs the conversion.

impl Hash for Index

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IntoIterator for Index

type Item = usize

The type of the elements being iterated over.

type IntoIter = IntoIter<usize>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <Index as IntoIterator>::IntoIter

Creates an iterator from a value.

impl Mul<usize> for Index

type Output = Index

The resulting type after applying the * operator.

pub fn mul(self, rhs: usize) -> Index

Performs the * operation.

impl Ord for Index

pub fn cmp(&self, other: &Index) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

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

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

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

This method tests for !=.

impl PartialEq<usize> for Index

pub fn eq(&self, other: &usize) -> 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 !=.

impl PartialOrd<Index> for Index

pub fn partial_cmp(&self, other: &Index) -> 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 PartialOrd<usize> for Index

pub fn partial_cmp(&self, other: &usize) -> 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 Rem<usize> for Index

type Output = Index

The resulting type after applying the % operator.

pub fn rem(self, rhs: usize) -> Index

Performs the % operation.

impl Sub<Index> for Index

type Output = Index

The resulting type after applying the - operator.

pub fn sub(self, rhs: Index) -> Index

Performs the - operation.

impl Sub<usize> for Index

type Output = Index

The resulting type after applying the - operator.

pub fn sub(self, rhs: usize) -> Index

Performs the - operation.

impl Zeroable for Index

fn zeroed() -> Self

Calls zeroed.

impl Copy for Index

impl Eq for Index

impl Pod for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index