Struct KeyRange 

pub struct KeyRange { /* private fields */ }

An inclusive range of u64 keys, [start, end].

Construct one with new (which rejects start > end) or point for a single key. Two ranges held by different transactions conflict only when they overlap and their lock modes are incompatible.

Examples

use lock_db::KeyRange;

let r = KeyRange::new(100, 200).unwrap();
assert!(r.contains(150));
assert!(!r.contains(201));
assert!(r.overlaps(KeyRange::point(200)));
assert!(!r.overlaps(KeyRange::new(201, 300).unwrap()));

// An inverted range is rejected.
assert!(KeyRange::new(5, 4).is_none());

Implementations

impl KeyRange

pub const fn new(start: u64, end: u64) -> Option<Self>

Creates the inclusive range [start, end], or None if start > end.

Examples

use lock_db::KeyRange;

assert!(KeyRange::new(0, 0).is_some()); // a single key
assert!(KeyRange::new(1, 9).is_some());
assert!(KeyRange::new(9, 1).is_none());

pub const fn point(key: u64) -> Self

Creates a range covering the single key key.

Examples

use lock_db::KeyRange;

let k = KeyRange::point(42);
assert_eq!(k.start(), 42);
assert_eq!(k.end(), 42);

pub const fn start(self) -> u64

Returns the inclusive lower bound.

pub const fn end(self) -> u64

Returns the inclusive upper bound.

pub const fn contains(self, key: u64) -> bool

Returns true if key falls within the range.

Examples

use lock_db::KeyRange;

let r = KeyRange::new(10, 20).unwrap();
assert!(r.contains(10) && r.contains(20));
assert!(!r.contains(9) && !r.contains(21));

pub const fn overlaps(self, other: KeyRange) -> bool

Returns true if the two ranges share at least one key.

Overlap is symmetric: a.overlaps(b) == b.overlaps(a).

Examples

use lock_db::KeyRange;

let a = KeyRange::new(10, 20).unwrap();
assert!(a.overlaps(KeyRange::new(20, 30).unwrap())); // touch at 20
assert!(!a.overlaps(KeyRange::new(21, 30).unwrap()));

Trait Implementations

impl Clone for KeyRange

fn clone(&self) -> KeyRange

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for KeyRange

impl Debug for KeyRange

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyRange

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KeyRange

impl Hash for KeyRange

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyRange

fn eq(&self, other: &KeyRange) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KeyRange

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KeyRange