Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand Handles API #2036

Merged
merged 4 commits into from
Sep 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions crates/fj-core/src/objects/handles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,36 @@ impl<T> Handles<T> {
self.inner.is_empty()
}

/// Return the only item
///
/// # Panics
///
/// Panics, if there is more than one item.
pub fn only(&self) -> &Handle<T> {
let mut iter = self.inner.iter();
let item = iter
.next()
.expect("Requested only item, but no items available");

assert!(
iter.next().is_none(),
"Requested only item, but more than one available"
);

item
}

/// Return the first item
///
/// # Panics
///
/// Panics, if there are no items.
pub fn first(&self) -> &Handle<T> {
self.inner
.first()
.expect("Requested first item, but no items available")
}

/// Return the n-th item
pub fn nth(&self, index: usize) -> Option<&Handle<T>> {
self.inner.get(index)
Expand All @@ -70,7 +100,13 @@ impl<T> Handles<T> {
///
/// If the length of `Handles` is `i`, then retrieving the i-th edge using
/// this method, is the same as retrieving the 0-th one.
///
/// # Panics
///
/// Panics, if `Handles` is empty.
pub fn nth_circular(&self, index: usize) -> &Handle<T> {
assert!(!self.is_empty(), "`Handles` must not be empty");

let index = index % self.len();
self.nth(index)
.expect("Index must be valid, due to modulo above")
Expand Down