Struct spade::internals::FixedHandleImpl

pub struct FixedHandleImpl<Type, InnerOuter: InnerOuterMarker> { /* private fields */ }

Internal type definition that is only exposed for documentation purposes.

Rust will currently not generate documentation for type definitions depending pub(crate) types, see #32077.

Do not use these types. Their removal will not be considered a breaking change.

Implementations

impl FixedHandleImpl<VertexTag, InnerTag>

pub fn from_index(index: usize) -> Self

Creates a new vertex handle from a usize.

Ideally, this method should only be used in advanced scenarios as it allows to create invalid vertex handles. When possible, attempt to retrieve handles by other means instead (see crate::handles).

Panics

Panics if index >= 2^32

impl<Type: Default, InnerOuter: InnerOuterMarker> FixedHandleImpl<Type, InnerOuter>

pub fn index(&self) -> usize

Returns the internal index of this element.

Indices of the same handle type are guaranteed to be unique (e.g. different vertices will have different indices from each other).

Indices will always be in the interval 0 .. number_of_elements (e.g. the number of directed edges).

Adding vertices will not change any indices. Vertex removal does affect indices - the index of elements may change to swap-fill any gaps that were created.

impl FixedHandleImpl<DirectedEdgeTag, InnerTag>

pub fn rev(self) -> Self

Returns this edge with its direction reversed.

If this edge points from v0 to v1, the returned edge would point from v1 to v0. Calling rev twice will always return the original vertex.

pub fn as_undirected(self) -> FixedUndirectedEdgeHandle

Converts this directed edge handle into an undirected edge handle.

See also the handles module for more information.

impl FixedHandleImpl<FaceTag, PossiblyOuterTag>

pub fn is_outer(&self) -> bool

Returns true if this face is the single outer face.

pub fn as_inner(&self) -> Option<FixedFaceHandle<InnerTag>>

Converts this face handle to an inner face.

Returns None if this handle refers to the single outer face.

impl FixedHandleImpl<UndirectedEdgeTag, InnerTag>

pub fn as_directed(&self) -> FixedDirectedEdgeHandle

Converts this directed edge into an undirected edge handle.

Any of the two directed edges may be returned.

See also FixedDirectedEdgeHandle::as_undirected

pub fn directed_edges(&self) -> [FixedDirectedEdgeHandle; 2]

Returns the two directed edges of this undirected edge in any order.

Trait Implementations

impl<Type: Clone, InnerOuter: Clone + InnerOuterMarker> Clone for FixedHandleImpl<Type, InnerOuter>

fn clone(&self) -> FixedHandleImpl<Type, InnerOuter>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Type, InnerOuter: InnerOuterMarker> Debug for FixedHandleImpl<Type, InnerOuter>

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

Formats the value using the given formatter.

impl<Type: Hash, InnerOuter: Hash + InnerOuterMarker> Hash for FixedHandleImpl<Type, InnerOuter>

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<Type: Ord, InnerOuter: Ord + InnerOuterMarker> Ord for FixedHandleImpl<Type, InnerOuter>

fn cmp(&self, other: &FixedHandleImpl<Type, InnerOuter>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<Type: PartialEq, InnerOuter: PartialEq + InnerOuterMarker> PartialEq for FixedHandleImpl<Type, InnerOuter>

fn eq(&self, other: &FixedHandleImpl<Type, InnerOuter>) -> 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<Type: PartialOrd, InnerOuter: PartialOrd + InnerOuterMarker> PartialOrd for FixedHandleImpl<Type, InnerOuter>

fn partial_cmp( &self, other: &FixedHandleImpl<Type, InnerOuter> ) -> 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<Type: Copy, InnerOuter: Copy + InnerOuterMarker> Copy for FixedHandleImpl<Type, InnerOuter>

impl<Type: Eq, InnerOuter: Eq + InnerOuterMarker> Eq for FixedHandleImpl<Type, InnerOuter>

impl<Type, InnerOuter: InnerOuterMarker> StructuralPartialEq for FixedHandleImpl<Type, InnerOuter>