Struct ResourceId 

pub struct ResourceId(/* private fields */);

Identifies a lockable resource.

A resource is whatever the caller decides to protect with a lock: an entire database, a table, a page, or a single row. The caller is responsible for mapping its own object identity to a stable, collision-free u64. Two distinct resources that map to the same id will share a lock queue, which is a correctness bug in the caller’s id scheme, not in lock-db.

Examples

use lock_db::ResourceId;

let page = ResourceId::new(0xDEAD_BEEF);
assert_eq!(page.get(), 0xDEAD_BEEF);

Implementations

impl ResourceId

pub const fn new(id: u64) -> Self

Wraps a raw resource number.

pub const fn get(self) -> u64

Returns the underlying number.

Trait Implementations

impl Clone for ResourceId

fn clone(&self) -> ResourceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ResourceId

impl Debug for ResourceId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResourceId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ResourceId

impl From<ResourceId> for u64

fn from(id: ResourceId) -> Self

Converts to this type from the input type.

impl From<u64> for ResourceId

fn from(id: u64) -> Self

Converts to this type from the input type.

impl Hash for ResourceId

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 Ord for ResourceId

fn cmp(&self, other: &ResourceId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ResourceId

fn eq(&self, other: &ResourceId) -> 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 PartialOrd for ResourceId

fn partial_cmp(&self, other: &ResourceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ResourceId

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 ResourceId