Skip to content

Commit

Permalink
Revise signature of raxSeek in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
fxn committed Nov 26, 2023
1 parent 1927550 commit ead9b67
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ of 'seek', which is not 'seeked', in case you wonder) in order to start
the iteration from the specified position. For this goal, the function
`raxSeek` is used:

int raxSeek(raxIterator *it, unsigned char *ele, size_t len, const char *op);
int raxSeek(raxIterator *it, const char *op, unsigned char *ele, size_t len);

For instance one may want to seek the first element greater or equal to the
key `"foo"`:
Expand All @@ -189,7 +189,7 @@ key `"foo"`:

The function raxSeek() returns 1 on success, or 0 on failure. Possible failures are:

1. An invalid operator was passed as last argument.
1. An invalid operator was passed as second argument.
2. An out of memory condition happened while seeking the iterator.

Once the iterator is sought, it is possible to iterate using the function
Expand Down

0 comments on commit ead9b67

Please sign in to comment.