From f4ba9ddb6d7783c4df18ff15de9cdea2253fdd3b Mon Sep 17 00:00:00 2001 From: Pierre Krieger Date: Thu, 7 Dec 2017 12:34:12 +0100 Subject: [PATCH] Fix concerns --- datastore/README.md | 8 ++++---- datastore/src/lib.rs | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/datastore/README.md b/datastore/README.md index 07d8548f..e0783c35 100644 --- a/datastore/README.md +++ b/datastore/README.md @@ -16,7 +16,7 @@ and `Clone` traits. The `JsonFileDatastore::new` method will attempt to load existing data from the path you pass as parameter. This path is also where the data will be stored. The content of the store is -flushed on destruction or if you call `flush()`. +flushed on drop or if you call `flush()`. ```rust use datastore::Datastore; @@ -37,9 +37,9 @@ a way to perform queries on the key-value storage, using the `query` method. The struct returned by the `query` method implements the `Stream` trait from `futures`, meaning that the result is asynchronous. -> **Note**: For now the `get` and `has` methods are theoretically blocking, but the only -> available implementation doesn't do any I/O. Maybe these methods will be made -> asynchronous in the future, if deemed necessary. +> **Note**: For now the API of the `get` and `has` methods makes them potentially blocking +> operations, though the only available implementation doesn't block. The API of these +> methods may become asynchronous in the future if deemed necessary. ```rust extern crate datastore; diff --git a/datastore/src/lib.rs b/datastore/src/lib.rs index 839d1666..f7bbe00e 100644 --- a/datastore/src/lib.rs +++ b/datastore/src/lib.rs @@ -39,7 +39,7 @@ //! //! The `JsonFileDatastore::new` method will attempt to load existing data from the path you pass //! as parameter. This path is also where the data will be stored. The content of the store is -//! flushed on destruction or if you call `flush()`. +//! flushed on drop or if you call `flush()`. //! //! ```no_run //! use datastore::Datastore; @@ -60,9 +60,9 @@ //! The struct returned by the `query` method implements the `Stream` trait from `futures`, //! meaning that the result is asynchronous. //! -//! > **Note**: For now the `get` and `has` methods are theoretically blocking, but the only -//! > available implementation doesn't do any I/O. Maybe these methods will be made -//! > asynchronous in the future, if deemed necessary. +//! > **Note**: For now the API of the `get` and `has` methods makes them potentially blocking +//! > operations, though the only available implementation doesn't block. The API of these +//! > methods may become asynchronous in the future if deemed necessary. //! //! ```no_run //! extern crate datastore;