[−][src]Struct gut::index::Index

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.

Methods

`impl Index`[src]

`pub const INVALID: Index`[src]

Invalid index instance.

`pub fn new(i: usize) -> Index`[src]

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>`[src]

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

`pub fn map_inner<F: FnOnce(usize) -> usize>(self, f: F) -> Index`[src]

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`[src]

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

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

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

`pub fn if_valid<F: FnOnce(usize)>(self, f: F)`[src]

Apply a function to the inner usize index.

`pub fn into_inner(self) -> usize`[src]

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

Trait Implementations

`impl CheckedIndex<usize> for Index`[src]

`fn invalid() -> Self`[src]

`fn is_valid(&self) -> bool`[src]

`fn unwrap(self) -> usize`[src]

`fn expect(self, msg: &str) -> usize`[src]

`fn map<F: FnOnce(usize) -> usize>(self, f: F) -> Index`[src]

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

`fn into_inner(self) -> usize`[src]

`impl From<usize> for Index`[src]

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

`fn from(i: usize) -> Self`[src]

`impl From<u64> for Index`[src]

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

`fn from(i: u64) -> Self`[src]

`impl From<u32> for Index`[src]

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

`fn from(i: u32) -> Self`[src]

`impl From<u16> for Index`[src]

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

`fn from(i: u16) -> Self`[src]

`impl From<u8> for Index`[src]

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

`fn from(i: u8) -> Self`[src]

`impl From<isize> for Index`[src]

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`[src]

`impl From<i64> for Index`[src]

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`[src]

`impl From<i32> for Index`[src]

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`[src]

`impl From<i16> for Index`[src]

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`[src]

`impl From<i8> for Index`[src]

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`[src]

`impl From<Option<usize>> for Index`[src]

`fn from(i: Option<usize>) -> Index`[src]

`impl From<MeshIndex> for Index`[src]

`fn from(i: MeshIndex) -> Self`[src]

`impl From<Option<MeshIndex>> for Index`[src]

`fn from(mb_i: Option<MeshIndex>) -> Self`[src]

`impl From<Index> for MeshIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<VertexIndex> for Index`[src]

`fn from(i: VertexIndex) -> Self`[src]

`impl From<Option<VertexIndex>> for Index`[src]

`fn from(mb_i: Option<VertexIndex>) -> Self`[src]

`impl From<Index> for VertexIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<EdgeIndex> for Index`[src]

`fn from(i: EdgeIndex) -> Self`[src]

`impl From<Option<EdgeIndex>> for Index`[src]

`fn from(mb_i: Option<EdgeIndex>) -> Self`[src]

`impl From<Index> for EdgeIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<FaceIndex> for Index`[src]

`fn from(i: FaceIndex) -> Self`[src]

`impl From<Option<FaceIndex>> for Index`[src]

`fn from(mb_i: Option<FaceIndex>) -> Self`[src]

`impl From<Index> for FaceIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<CellIndex> for Index`[src]

`fn from(i: CellIndex) -> Self`[src]

`impl From<Option<CellIndex>> for Index`[src]

`fn from(mb_i: Option<CellIndex>) -> Self`[src]

`impl From<Index> for CellIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<EdgeVertexIndex> for Index`[src]

`fn from(i: EdgeVertexIndex) -> Self`[src]

`impl From<Option<EdgeVertexIndex>> for Index`[src]

`fn from(mb_i: Option<EdgeVertexIndex>) -> Self`[src]

`impl From<Index> for EdgeVertexIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<FaceVertexIndex> for Index`[src]

`fn from(i: FaceVertexIndex) -> Self`[src]

`impl From<Option<FaceVertexIndex>> for Index`[src]

`fn from(mb_i: Option<FaceVertexIndex>) -> Self`[src]

`impl From<Index> for FaceVertexIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<FaceEdgeIndex> for Index`[src]

`fn from(i: FaceEdgeIndex) -> Self`[src]

`impl From<Option<FaceEdgeIndex>> for Index`[src]

`fn from(mb_i: Option<FaceEdgeIndex>) -> Self`[src]

`impl From<Index> for FaceEdgeIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<CellVertexIndex> for Index`[src]

`fn from(i: CellVertexIndex) -> Self`[src]

`impl From<Option<CellVertexIndex>> for Index`[src]

`fn from(mb_i: Option<CellVertexIndex>) -> Self`[src]

`impl From<Index> for CellVertexIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<CellEdgeIndex> for Index`[src]

`fn from(i: CellEdgeIndex) -> Self`[src]

`impl From<Option<CellEdgeIndex>> for Index`[src]

`fn from(mb_i: Option<CellEdgeIndex>) -> Self`[src]

`impl From<Index> for CellEdgeIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<CellFaceIndex> for Index`[src]

`fn from(i: CellFaceIndex) -> Self`[src]

`impl From<Option<CellFaceIndex>> for Index`[src]

`fn from(mb_i: Option<CellFaceIndex>) -> Self`[src]

`impl From<Index> for CellFaceIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<VertexEdgeIndex> for Index`[src]

`fn from(i: VertexEdgeIndex) -> Self`[src]

`impl From<Option<VertexEdgeIndex>> for Index`[src]

`fn from(mb_i: Option<VertexEdgeIndex>) -> Self`[src]

`impl From<Index> for VertexEdgeIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<VertexFaceIndex> for Index`[src]

`fn from(i: VertexFaceIndex) -> Self`[src]

`impl From<Option<VertexFaceIndex>> for Index`[src]

`fn from(mb_i: Option<VertexFaceIndex>) -> Self`[src]

`impl From<Index> for VertexFaceIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<VertexCellIndex> for Index`[src]

`fn from(i: VertexCellIndex) -> Self`[src]

`impl From<Option<VertexCellIndex>> for Index`[src]

`fn from(mb_i: Option<VertexCellIndex>) -> Self`[src]

`impl From<Index> for VertexCellIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<EdgeFaceIndex> for Index`[src]

`fn from(i: EdgeFaceIndex) -> Self`[src]

`impl From<Option<EdgeFaceIndex>> for Index`[src]

`fn from(mb_i: Option<EdgeFaceIndex>) -> Self`[src]

`impl From<Index> for EdgeFaceIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<EdgeCellIndex> for Index`[src]

`fn from(i: EdgeCellIndex) -> Self`[src]

`impl From<Option<EdgeCellIndex>> for Index`[src]

`fn from(mb_i: Option<EdgeCellIndex>) -> Self`[src]

`impl From<Index> for EdgeCellIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl From<FaceCellIndex> for Index`[src]

`fn from(i: FaceCellIndex) -> Self`[src]

`impl From<Option<FaceCellIndex>> for Index`[src]

`fn from(mb_i: Option<FaceCellIndex>) -> Self`[src]

`impl From<Index> for FaceCellIndex`[src]

`fn from(i: Index) -> Self`[src]

`impl Into<Option<usize>> for Index`[src]

`fn into(self) -> Option<usize>`[src]

`impl Clone for Index`[src]

`fn clone(&self) -> Index`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Index`[src]

`impl Default for Index`[src]

`fn default() -> Self`[src]

`impl Eq for Index`[src]

`impl Ord for Index`[src]

`fn cmp(&self, other: &Index) -> Ordering`[src]

`fn max(self, other: Self) -> Self`1.21.0[src]

`fn min(self, other: Self) -> Self`1.21.0[src]

`fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl PartialEq<Index> for Index`[src]

`fn eq(&self, other: &Index) -> bool`[src]

`fn ne(&self, other: &Index) -> bool`[src]

`impl PartialEq<usize> for Index`[src]

`fn eq(&self, other: &usize) -> bool`[src]

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

`impl PartialOrd<Index> for Index`[src]

`fn partial_cmp(&self, other: &Index) -> Option<Ordering>`[src]

`fn lt(&self, other: &Index) -> bool`[src]

`fn le(&self, other: &Index) -> bool`[src]

`fn gt(&self, other: &Index) -> bool`[src]

`fn ge(&self, other: &Index) -> bool`[src]

`impl PartialOrd<usize> for Index`[src]

`fn partial_cmp(&self, other: &usize) -> Option<Ordering>`[src]

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

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

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

`#[must_use] fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl Debug for Index`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Display for Index`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Div<usize> for Index`[src]

`type Output = Index`

The resulting type after applying the / operator.

`fn div(self, rhs: usize) -> Index`[src]

`impl Rem<usize> for Index`[src]

`type Output = Index`

The resulting type after applying the % operator.

`fn rem(self, rhs: usize) -> Index`[src]

`impl Sub<usize> for Index`[src]

`type Output = Index`

The resulting type after applying the - operator.

`fn sub(self, rhs: usize) -> Index`[src]

`impl Sub<Index> for usize`[src]

`type Output = Index`

The resulting type after applying the - operator.

`fn sub(self, rhs: Index) -> Index`[src]

`impl Sub<Index> for Index`[src]

`type Output = Index`

The resulting type after applying the - operator.

`fn sub(self, rhs: Index) -> Index`[src]

`impl Add<usize> for Index`[src]

`type Output = Index`

The resulting type after applying the + operator.

`fn add(self, rhs: usize) -> Index`[src]

`impl Add<Index> for usize`[src]

`type Output = Index`

The resulting type after applying the + operator.

`fn add(self, rhs: Index) -> Index`[src]

`impl Add<Index> for Index`[src]

`type Output = Index`

The resulting type after applying the + operator.

`fn add(self, rhs: Index) -> Index`[src]

`impl Mul<usize> for Index`[src]

`type Output = Index`

The resulting type after applying the * operator.

`fn mul(self, rhs: usize) -> Index`[src]

`impl Mul<Index> for usize`[src]

`type Output = Index`

The resulting type after applying the * operator.

`fn mul(self, rhs: Index) -> Index`[src]

`impl AddAssign<usize> for Index`[src]

`fn add_assign(&mut self, rhs: usize)`[src]

`impl Hash for Index`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

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

`impl StructuralPartialEq for Index`[src]

`impl StructuralEq for Index`[src]

Auto Trait Implementations

`impl Send for Index`

`impl Sync for Index`

`impl Unpin for Index`

`impl UnwindSafe for Index`

`impl RefUnwindSafe for Index`

Blanket Implementations

`impl<T> Bytes for T`[src]

`fn as_bytes(&self) -> &[u8]`[src]

`fn interpret_bytes(bytes: &[u8]) -> &Self`[src]

`impl<T> Pod for T where T: 'static + Copy + Send + Sync + Any,` [src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = !`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T, Rhs, Output> NumOps<Rhs, Output> for T where T: Sub<Rhs, Output = Output> + Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Add<Rhs, Output = Output> + Rem<Rhs, Output = Output>,` [src]