tikv
/
client-rust
mirror of https://github.com/tikv/client-rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: BoundRange 

Signed-off-by: ekexium <ekexium@gmail.com>
This commit is contained in:
ekexium 2020-11-10 15:06:23 +08:00
parent b1bf7f6218
commit 1ce67462d1
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/kv/bound_range.rs
View File

@ -23,12 +23,13 @@ use tikv_client_proto::kvrpcpb;
/// The unbounded lower bound in a [`Range`](Range) will be converted to an empty key.
///
/// **Maximum key**: There is no limit of the maximum key. When an empty key is used as the upper bound, it means upper unbounded.
/// The unbounded upper_bound in a [`Range`](Range). The range covering all keys is just `vec![]..`.
/// The unbounded upper bound in a [`Range`](Range). The range covering all keys is just `vec![]..`.
///
/// You don't have to know the real representation keys. The conversion from range types to `BoundRange` is intuitive.
/// `Into<BoundRange>` has implementations for common range types like `a..b`, `a..=b` where `a` and `b`
/// **But, you should not need to worry about all this:** Most functions which operate
/// on ranges will accept any types which implement `Into<BoundRange>`.
/// Common range types like `a..b`, `a..=b` has implemented `Into<BoundRange>`where `a` and `b`
/// `impl Into<Key>`. You can implement `Into<BoundRange>` for your own types by using `try_from`.
///
/// It means all of the following types in the example can be passed directly to those functions.
///
/// # Examples
/// ```rust
@ -58,9 +59,6 @@ use tikv_client_proto::kvrpcpb;
/// );
/// ```
///
/// **But, you should not need to worry about all this:** Most functions which operate
/// on ranges will accept any types which implement `Into<BoundRange>`.
/// It means all of the above types can be passed directly to those functions.
#[derive(Clone, Debug, Eq, PartialEq)]
#[cfg_attr(test, derive(Arbitrary))]
pub struct BoundRange {