Struct gut::index::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: FnOnce(usize) -> usize>(self, f: F) -> Index

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: FnOnce(usize) -> Index>(self, f: F) -> Index

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

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

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

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

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.

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

Performs the + operation.

impl Add<usize> for Index

type Output = Index

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<usize> for Index

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl CheckedIndex<usize> for Index

fn invalid() -> Self

Construct an invalid index.

fn is_valid(&self) -> bool

Check if the index is valid.

fn unwrap(self) -> usize

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

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

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

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

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

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

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

fn into_inner(self) -> usize

Produce the raw inner type without checking.

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Index

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Self

Returns the "default value" for a type.

impl Display for Index

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

Formats the value using the given formatter.

impl Div<usize> for Index

type Output = Index

The resulting type after applying the / operator.

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

Performs the / operation.

impl Eq for Index

impl From<CellEdgeIndex> for Index

fn from(i: CellEdgeIndex) -> Self

Performs the conversion.

impl From<CellFaceIndex> for Index

fn from(i: CellFaceIndex) -> Self

Performs the conversion.

impl From<CellIndex> for Index

fn from(i: CellIndex) -> Self

Performs the conversion.

impl From<CellVertexIndex> for Index

fn from(i: CellVertexIndex) -> Self

Performs the conversion.

impl From<EdgeCellIndex> for Index

fn from(i: EdgeCellIndex) -> Self

Performs the conversion.

impl From<EdgeFaceIndex> for Index

fn from(i: EdgeFaceIndex) -> Self

Performs the conversion.

impl From<EdgeIndex> for Index

fn from(i: EdgeIndex) -> Self

Performs the conversion.

impl From<EdgeVertexIndex> for Index

fn from(i: EdgeVertexIndex) -> Self

Performs the conversion.

impl From<FaceCellIndex> for Index

fn from(i: FaceCellIndex) -> Self

Performs the conversion.

impl From<FaceEdgeIndex> for Index

fn from(i: FaceEdgeIndex) -> Self

Performs the conversion.

impl From<FaceIndex> for Index

fn from(i: FaceIndex) -> Self

Performs the conversion.

impl From<FaceVertexIndex> for Index

fn from(i: FaceVertexIndex) -> Self

Performs the conversion.

impl From<Index> for MeshIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for VertexIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for CellFaceIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for VertexEdgeIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for VertexFaceIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for VertexCellIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for EdgeFaceIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for EdgeCellIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for FaceCellIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for EdgeIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for FaceIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for CellIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for EdgeVertexIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for FaceVertexIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for FaceEdgeIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for CellVertexIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<Index> for CellEdgeIndex

fn from(i: Index) -> Self

Performs the conversion.

impl From<MeshIndex> for Index

fn from(i: MeshIndex) -> Self

Performs the conversion.

impl From<Option<CellEdgeIndex>> for Index

fn from(mb_i: Option<CellEdgeIndex>) -> Self

Performs the conversion.

impl From<Option<CellFaceIndex>> for Index

fn from(mb_i: Option<CellFaceIndex>) -> Self

Performs the conversion.

impl From<Option<CellIndex>> for Index

fn from(mb_i: Option<CellIndex>) -> Self

Performs the conversion.

impl From<Option<CellVertexIndex>> for Index

fn from(mb_i: Option<CellVertexIndex>) -> Self

Performs the conversion.

impl From<Option<EdgeCellIndex>> for Index

fn from(mb_i: Option<EdgeCellIndex>) -> Self

Performs the conversion.

impl From<Option<EdgeFaceIndex>> for Index

fn from(mb_i: Option<EdgeFaceIndex>) -> Self

Performs the conversion.

impl From<Option<EdgeIndex>> for Index

fn from(mb_i: Option<EdgeIndex>) -> Self

Performs the conversion.

impl From<Option<EdgeVertexIndex>> for Index

fn from(mb_i: Option<EdgeVertexIndex>) -> Self

Performs the conversion.

impl From<Option<FaceCellIndex>> for Index

fn from(mb_i: Option<FaceCellIndex>) -> Self

Performs the conversion.

impl From<Option<FaceEdgeIndex>> for Index

fn from(mb_i: Option<FaceEdgeIndex>) -> Self

Performs the conversion.

impl From<Option<FaceIndex>> for Index

fn from(mb_i: Option<FaceIndex>) -> Self

Performs the conversion.

impl From<Option<FaceVertexIndex>> for Index

fn from(mb_i: Option<FaceVertexIndex>) -> Self

Performs the conversion.

impl From<Option<MeshIndex>> for Index

fn from(mb_i: Option<MeshIndex>) -> Self

Performs the conversion.

impl From<Option<VertexCellIndex>> for Index

fn from(mb_i: Option<VertexCellIndex>) -> Self

Performs the conversion.

impl From<Option<VertexEdgeIndex>> for Index

fn from(mb_i: Option<VertexEdgeIndex>) -> Self

Performs the conversion.

impl From<Option<VertexFaceIndex>> for Index

fn from(mb_i: Option<VertexFaceIndex>) -> Self

Performs the conversion.

impl From<Option<VertexIndex>> for Index

fn from(mb_i: Option<VertexIndex>) -> Self

Performs the conversion.

impl From<Option<usize>> for Index

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

Performs the conversion.

impl From<VertexCellIndex> for Index

fn from(i: VertexCellIndex) -> Self

Performs the conversion.

impl From<VertexEdgeIndex> for Index

fn from(i: VertexEdgeIndex) -> Self

Performs the conversion.

impl From<VertexFaceIndex> for Index

fn from(i: VertexFaceIndex) -> Self

Performs the conversion.

impl From<VertexIndex> for Index

fn from(i: VertexIndex) -> Self

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.

fn from(i: i16) -> Self

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.

fn from(i: i32) -> Self

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.

fn from(i: i64) -> Self

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.

fn from(i: i8) -> Self

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.

fn from(i: isize) -> Self

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.

fn from(i: u16) -> Self

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.

fn from(i: u32) -> Self

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.

fn from(i: u64) -> Self

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.

fn from(i: u8) -> Self

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.

fn from(i: usize) -> Self

Performs the conversion.

impl Hash for Index

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Into<Option<usize>> for Index

fn into(self) -> Option<usize>

Performs the conversion.

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?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul<usize> for Index

type Output = Index

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for Index

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

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

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

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

This method tests for !=.

impl PartialEq<usize> for Index

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Index> for Index

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: &Index) -> bool

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

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

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

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

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

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

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

impl PartialOrd<usize> for Index

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Pod for Index

impl Rem<usize> for Index

type Output = Index

The resulting type after applying the % operator.

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

Performs the % operation.

impl StructuralEq for Index

impl StructuralPartialEq for Index

impl Sub<Index> for Index

type Output = Index

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<usize> for Index

type Output = Index

The resulting type after applying the - operator.

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

Performs the - operation.

impl Zeroable for Index

pub fn zeroed() -> Self

Calls zeroed.