Struct fj_core::objects::ObjectSet

pub struct ObjectSet<T> { /* private fields */ }

An ordered set of objects

This is the data structure used by all objects that reference multiple objects of the same type. It is a set, not containing any duplicate elements, and it maintains the insertion order of those elements.

Implementations

impl<T> ObjectSet<T>

pub fn new(handles: impl IntoIterator<Item = Handle<T>>) -> Self

where T: Debug + Ord,

Create an instances of ObjectSet from an iterator over Handle<T>

Panics

Panics, if the iterator contains duplicate Handles.

pub fn len(&self) -> usize

Return the number of objects in this set

pub fn is_empty(&self) -> bool

Indicate whether the set is empty

pub fn contains(&self, object: &Handle<T>) -> bool

Indicate whether the set contains the provided object

pub fn only(&self) -> &Handle<T>

Return the only item

Panics

Panics, if there is more than one item.

pub fn first(&self) -> &Handle<T>

Return the first item

Panics

Panics, if there are no items.

pub fn nth(&self, index: usize) -> Option<&Handle<T>>

Return the n-th item

pub fn nth_circular(&self, index: usize) -> &Handle<T>

Return the n-th item, treating the index space as circular

If the length of ObjectSet is i, then retrieving the i-th edge using this method, is the same as retrieving the 0-th one, and so on.

Panics

Panics, if ObjectSet is empty.

pub fn index_of(&self, handle: &Handle<T>) -> Option<usize>

Return the index of the item, if available

pub fn after(&self, handle: &Handle<T>) -> Option<&Handle<T>>

Access the item after the provided one

Returns None, if the provided item is not in this iterator.

pub fn iter(&self) -> Iter<'_, Handle<T>>

Access an iterator over the objects

pub fn pairs(&self) -> impl Iterator<Item = (&Handle<T>, &Handle<T>)>

Access an iterator over the neighboring pairs of all contained objects

pub fn replace<const N: usize>( &self, original: &Handle<T>, replacements: [Handle<T>; N] ) -> Option<Self>

where T: Debug + Ord,

Create a new instance in which the provided object has been replaced

Returns None, if the provided item is not present.

Panics

Panics, if the update results in a duplicate item.

Trait Implementations

impl Approx for &ObjectSet<Face>

type Approximation = BTreeSet<FaceApprox>

The approximation of the object

type Cache = HalfEdgeApproxCache

The cache used to cache approximation results

fn approx_with_cache( self, tolerance: impl Into<Tolerance>, cache: &mut Self::Cache ) -> Self::Approximation

Approximate the object, using the provided cache

fn approx(self, tolerance: impl Into<Tolerance>) -> Self::Approximation

Approximate the object

impl<T: Clone> Clone for ObjectSet<T>

fn clone(&self) -> ObjectSet<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ObjectSet<T>

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

Formats the value using the given formatter.

impl<O> FromIterator<Handle<O>> for ObjectSet<O>

where O: Debug + Ord,

fn from_iter<T: IntoIterator<Item = Handle<O>>>(handles: T) -> Self

Creates a value from an iterator.

impl<T: Hash> Hash for ObjectSet<T>

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<'r, T> IntoIterator for &'r ObjectSet<T>

type Item = &'r Handle<T>

The type of the elements being iterated over.

type IntoIter = Iter<'r, Handle<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for ObjectSet<T>

type Item = Handle<T>

The type of the elements being iterated over.

type IntoIter = IntoIter<Handle<T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for ObjectSet<T>

fn cmp(&self, other: &ObjectSet<T>) -> 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<T: PartialEq> PartialEq for ObjectSet<T>

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

fn partial_cmp(&self, other: &ObjectSet<T>) -> 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<T: Eq> Eq for ObjectSet<T>

impl<T> StructuralEq for ObjectSet<T>

impl<T> StructuralPartialEq for ObjectSet<T>