Skip to content

doc: remove mention of lending iters from book #880

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.

Sign up for GitHub

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

Merged
molpopgen merged 1 commit into from
Apr 30, 2026
Merged

doc: remove mention of lending iters from book #880

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 0 additions & 17 deletions book/src/table_collection_row_access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,6 @@ To generate a row view using a row id:
{{#include ../../tests/book_table_collection.rs:get_edge_table_row_by_id}}
```

To iterate over all views we use *lending* iterators:

```rust, noplaygound, ignore
{{#include ../../tests/book_table_collection.rs:get_edge_table_rows_by_lending_iterator}}
```

#### Lending iterators

The lending iterators are implemented using the [`streaming_iterator`](https://docs.rs/streaming-iterator/latest/streaming_iterator/) crate.
(The community now prefers the term "lending" over "streaming" for this concept.)
The `tskit` prelude includes the trait declarations that allow the code shown above to compile.

rust 1.65.0 stabilized Generic Associated Types, or GATs.
GATs allows lending iterators to be implemented directly without the workarounds used in the `streaming_iterator` crate.
We have decided not to implement our own lending iterator using GATs.
Rather, we will see what the community settles on and will decide in the future whether or not to adopt it.

### Row objects

We may access entire table rows by a row id:
Expand Down
Loading