Struct Key

pub struct Key<H> {
    pub patch: H,
    pub line: LineId,
}

A node in the repository graph, made of a patch internal identifier, and a line identifier in that patch.

Fields

patch: H

The patch that introduced this node.

line: LineId

The line identifier of the node in that patch. Here, “line” does not imply anything on the contents of the chunk.

Implementations

impl Key<PatchId>

pub fn to_base58(&self) -> String

pub fn to_hex(&self) -> String

impl Key<Hash>

pub fn to_base58(&self) -> String

impl Key<PatchId>

pub fn is_root(&self) -> bool

Is this the root key? (the root key is all 0s).

pub fn from_hex(hex: &str) -> Option<Self>

Decode this key from its hexadecimal representation.

impl<T: Clone> Key<Option<T>>

pub fn unwrap_patch(&self) -> Key<T>

Trait Implementations

impl<T> AsRef<LineId> for Key<T>

fn as_ref(&self) -> &LineId

Converts this type into a shared reference of the (usually inferred) input type.

impl<H: Clone> Clone for Key<H>

fn clone(&self) -> Key<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: Debug> Debug for Key<H>

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

Formats the value using the given formatter.

impl<'de, H> Deserialize<'de> for Key<H>

where H: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H: Hash> Hash for Key<H>

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<H: Ord> Ord for Key<H>

fn cmp(&self, other: &Key<H>) -> 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<H: PartialEq> PartialEq for Key<H>

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

fn partial_cmp(&self, other: &Key<H>) -> 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 Representable for Key<PatchId>

type PageOffsets = Empty<u64>

An iterator over the offsets to pages contained in this value. Only values from this crate can generate non-empty iterators, but combined values (like tuples) must chain the iterators returned by method page_offsets.

fn alignment() -> Alignment

Alignment of this type. Allowed values are 1, 2, 4 and 8.

fn onpage_size(&self) -> u16

How much space this value occupies on the page (not counting alignment padding).

unsafe fn write_value(&self, p: *mut u8)

Write this value to a u8 pointer, guaranteed to be a multiple of self.alignment().

unsafe fn read_value(p: *const u8) -> Self

Read value from an onpage pointer, guaranteed to be a multiple of self.alignment().

unsafe fn cmp_value<T>(&self, _: &T, x: Self) -> Ordering

Compare a value with an onpage value. The current transaction is sometimes helpful, for instance when the page only stores a pointer to another page.

fn page_offsets(&self) -> Self::PageOffsets

If this value is an offset to another page at offset offset, return Some(offset). Return None else.

unsafe fn skip(p: *mut u8) -> *mut u8

First pointer strictly after this value’s pointer. The default implementation is basically p.offset(self.onpage_size() as isize), but their might be more efficient implementations in some cases.

fn drop_value<T, R>( &self, _: &mut MutTxn<'_, T>, _: &mut R, ) -> Result<(), Error>

where R: Rng,

How to free the pages used by this value. The default implementation doesn’t do anything, which is fine for types stored directly on B tree pages.

impl<H> Serialize for Key<H>

where H: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToHex for Key<PatchId>

fn write_hex<W: Write>(&self, w: &mut W) -> Result

Writes the hex string representing self into w. Lower case letters are used (e.g. f9b4ca).

fn write_hex_upper<W: Write>(&self, w: &mut W) -> Result

Writes the hex string representing self into w. Upper case letters are used (e.g. F9B4CA).

impl<H: Copy> Copy for Key<H>

impl<H: Eq> Eq for Key<H>

impl<H> StructuralPartialEq for Key<H>