prefixset: add iterators over prefixes

[database64128]

Closes #12.

[aromatt]

Thanks for this!

I looked for examples of iterators being added to existing packages with respect to naming, and didn't find anything.

I'm considering just using All() and AllCompact(), or even your original suggestion of repurposing Prefixes() and PrefixesCompact() since this package doesn't have many users yet.

I need to sign off for the evening but will follow up tomorrow.

[database64128]

I looked for examples of iterators being added to existing packages with respect to naming, and didn't find anything.

There's one in the standard library: golang/go#61901. They went with Lines, Bytes for new functions, and SplitSeq, FieldsSeq for iterator forms of existing functions, with the rationale being:

If we were writing the library from scratch, we might use the names Split, Fields, and Runes for the iterator-returning versions, and code that wanted the full slice could use slices.Collect. But that's not an option here, so we add a distinguishing Seq suffix. We do not expect that new functions will use the Seq suffix. For example the function above is Lines, not LinesSeq.

I'm considering just using All() and AllCompact(), or even your original suggestion of repurposing Prefixes() and PrefixesCompact() since this package doesn't have many users yet.

Both options look good to me. I'll update the PR when you make a decision.

[aromatt]

Both options look good to me. I'll update the PR when you make a decision.

Thanks for the examples. Since PrefixSet says what kind of element it stores right there in the name, I've decided to go with All and AllCompact.

This lets us keep parity with netipx's API for now, while moving forward with conventional names for iterators. It also nicely telegraphs names for PrefixMap iterators: All, Keys, and Values (plus respective *Compact versions).

[database64128]

Since PrefixSet says what kind of element it stores right there in the name, I've decided to go with All and AllCompact.

Done.

This lets us keep parity with netipx's API for now, while moving forward with conventional names for iterators. It also nicely telegraphs names for PrefixMap iterators: All, Keys, and Values (plus respective *Compact versions).

I'll open another PR for PrefixMap iterators.

[aromatt]

@database64128 would you like to update the commit message with the name changes before I merge?

[database64128]

would you like to update the commit message with the name changes before I merge?

Oops, missed that. Done.

[aromatt]

Looks good!