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.

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

fix function docs (clippy warnings) #273

Merged
merged 1 commit into from
Aug 17, 2024
Merged

fix function docs (clippy warnings) #273

Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions heed/src/cursor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ impl<'txn> RwCursor<'txn> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand Down Expand Up @@ -294,7 +294,7 @@ impl<'txn> RwCursor<'txn> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current(&mut self, key: &[u8], data: &[u8]) -> Result<bool> {
Expand Down Expand Up @@ -377,7 +377,7 @@ impl<'txn> RwCursor<'txn> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_flags(
Expand Down
8 changes: 4 additions & 4 deletions heed/src/env.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -765,9 +765,9 @@ impl Env {
///
/// * [`crate::MdbError::Panic`]: A fatal error occurred earlier, and the environment must be shut down
/// * [`crate::MdbError::MapResized`]: Another process wrote data beyond this [`Env`] mapsize and this env
/// map must be resized
/// map must be resized
/// * [`crate::MdbError::ReadersFull`]: a read-only transaction was requested, and the reader lock table is
/// full
/// full
pub fn read_txn(&self) -> Result<RoTxn> {
RoTxn::new(self)
}
Expand All @@ -794,9 +794,9 @@ impl Env {
///
/// * [`crate::MdbError::Panic`]: A fatal error occurred earlier, and the environment must be shut down
/// * [`crate::MdbError::MapResized`]: Another process wrote data beyond this [`Env`] mapsize and this env
/// map must be resized
/// map must be resized
/// * [`crate::MdbError::ReadersFull`]: a read-only transaction was requested, and the reader lock table is
/// full
/// full
pub fn static_read_txn(self) -> Result<RoTxn<'static>> {
RoTxn::static_read_txn(self)
}
Expand Down
12 changes: 6 additions & 6 deletions heed/src/iterator/iter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ impl<'txn, KC, DC, IM> RwIter<'txn, KC, DC, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -260,7 +260,7 @@ impl<'txn, KC, DC, IM> RwIter<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -319,7 +319,7 @@ impl<'txn, KC, DC, IM> RwIter<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down Expand Up @@ -582,7 +582,7 @@ impl<'txn, KC, DC, IM> RwRevIter<'txn, KC, DC, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -609,7 +609,7 @@ impl<'txn, KC, DC, IM> RwRevIter<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -668,7 +668,7 @@ impl<'txn, KC, DC, IM> RwRevIter<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down
12 changes: 6 additions & 6 deletions heed/src/iterator/prefix.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ impl<'txn, KC, DC, C, IM> RwPrefix<'txn, KC, DC, C, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -253,7 +253,7 @@ impl<'txn, KC, DC, C, IM> RwPrefix<'txn, KC, DC, C, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -312,7 +312,7 @@ impl<'txn, KC, DC, C, IM> RwPrefix<'txn, KC, DC, C, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down Expand Up @@ -616,7 +616,7 @@ impl<'txn, KC, DC, C, IM> RwRevPrefix<'txn, KC, DC, C, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -643,7 +643,7 @@ impl<'txn, KC, DC, C, IM> RwRevPrefix<'txn, KC, DC, C, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -702,7 +702,7 @@ impl<'txn, KC, DC, C, IM> RwRevPrefix<'txn, KC, DC, C, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down
12 changes: 6 additions & 6 deletions heed/src/iterator/range.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ impl<'txn, KC, DC, IM> RwRange<'txn, KC, DC, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -262,7 +262,7 @@ impl<'txn, KC, DC, IM> RwRange<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -321,7 +321,7 @@ impl<'txn, KC, DC, IM> RwRange<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down Expand Up @@ -672,7 +672,7 @@ impl<'txn, KC, DC, IM> RwRevRange<'txn, KC, DC, IM> {
/// while modifying it.
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn del_current(&mut self) -> Result<bool> {
Expand All @@ -699,7 +699,7 @@ impl<'txn, KC, DC, IM> RwRevRange<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current<'a>(
Expand Down Expand Up @@ -758,7 +758,7 @@ impl<'txn, KC, DC, IM> RwRevRange<'txn, KC, DC, IM> {
/// version of them (e.g. `&str` into `String`).
///
/// > [Values returned from the database are valid only until a subsequent update operation,
/// or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val).
/// > or the end of the transaction.](http://www.lmdb.tech/doc/group__mdb.html#structMDB__val)
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
pub unsafe fn put_current_with_options<'a, NDC>(
Expand Down
Loading