Skip to content

Revise signature of raxSeek in the README #47

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

Open
fxn wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Revise signature of raxSeek in the README #47

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
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