Struct DocId 

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

Available on crate feature std only.

A document’s primary key within a Db.

Ids are assigned by Db::insert as a dense, monotonically increasing sequence starting at 1; 0 is never assigned and can be used as a sentinel. The id is stable for the life of the document and survives reopening the file. Reconstruct one with DocId::from when you have stored it elsewhere.

Examples

use bison_db::DocId;
let id = DocId::from(7);
assert_eq!(id.get(), 7);
assert_eq!(id.to_string(), "7");

Implementations

impl DocId

pub const fn get(self) -> u64

Returns the underlying u64.

Examples

use bison_db::DocId;
assert_eq!(DocId::from(42).get(), 42);

Trait Implementations

impl Clone for DocId

fn clone(&self) -> DocId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DocId

impl Debug for DocId

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

Formats the value using the given formatter.

impl Display for DocId

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

Formats the value using the given formatter.

impl Eq for DocId

impl From<DocId> for u64

fn from(id: DocId) -> Self

Converts to this type from the input type.

impl From<u64> for DocId

fn from(raw: u64) -> Self

Converts to this type from the input type.

impl Hash for DocId

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 DocId

fn cmp(&self, other: &DocId) -> 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 DocId

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

fn partial_cmp(&self, other: &DocId) -> 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 StructuralPartialEq for DocId