Docs migrated to initial version#13
Merged
sunxiaoguang merged 3 commits intosun/raw_kv_initial_versionfrom Dec 31, 2018
Merged
Conversation
Signed-off-by: Hoverbear <operator@hoverbear.org>
Signed-off-by: Hoverbear <operator@hoverbear.org>
Hoverbear
force-pushed
the
docs-rebase
branch
from
51e81b6 to
0ebb7b0
Compare
Member
sunxiaoguang
left a comment
sunxiaoguang
left a comment
There was a problem hiding this comment.
@Hoverbear It's amazing you have done all these documentation in such short time. Great!.
| /// for errors. *This may change in future versions.* | ||
| #[derive(Debug)] | ||
| pub enum Error { | ||
| /// Wraps a a `std::io::Error`. |
| description("store not match") | ||
| display("requesting store '{}' when actual store is '{}'. {}", request_store_id, actual_store_id, message) | ||
| } | ||
| /// The given key is not eithin the given region. |
| /// In TiKV, keys are an ordered sequence of bytes. This has an advantage over choosing `String` as valid `UTF-8` is not required. This means that the user is permitted to store any data they wish, | ||
| /// as long as it can be represented by bytes. (Which is to say, pretty much anything!) | ||
| /// | ||
| /// This is a *wrapper type* that implements `Deref<Target=Vec<u8>>` so it can be used like one transparently. |
Member
| /// let connect = Client::new(&Config::default()); | ||
| /// let client = connect.wait(); | ||
| /// ``` | ||
| #[cfg_attr(feature = "cargo-clippy", allow(clippy::new_ret_no_self))] |
Member
There was a problem hiding this comment.
I guess feature = "cargo-chippy" can be removed now?
| /// | ||
| /// Once resolved this request will result in a scanner over the given keys. | ||
| /// | ||
| /// If not passed a `limit` parameter, it will default to `u32::MAX`. |
Member
There was a problem hiding this comment.
Shell we put a rational limit on this? Like what Go client does.
| /// | ||
| /// Once resolved this request will result in the deletion of all keys over the given range. | ||
| /// | ||
| /// If not passed a `limit` parameter, it will default to `u32::MAX`. |
Member
There was a problem hiding this comment.
DeleteRange has no number of pairs limit, so we can remove this line.
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@sunxiaoguang PTAL and merge freely, this isn't going to master, but your branch. :)