Skip to main content

Frontier

Struct Frontier 

Source
pub struct Frontier(pub SmallVec<LV, 2>);
Expand description

A LocalFrontier is a set of local Time values which point at the set of changes with no children at this point in time. When there’s a single writer this will always just be the last local version we’ve seen.

The start of time is named with an empty list.

A frontier must always remain sorted (in numerical order). Note: This is not checked when deserializing via serde!

Tuple Fields§

§0: SmallVec<LV, 2>

Implementations§

Source§

impl Frontier

Source

pub fn root() -> Self

Source

pub fn new_1(v: LV) -> Self

Source

pub fn from_unsorted(data: &[LV]) -> Self

Source

pub fn from_unsorted_iter<I: Iterator<Item = LV>>(iter: I) -> Self

Source

pub fn from_sorted(data: &[LV]) -> Self

Source

pub fn len(&self) -> usize

Frontiers should always be sorted smallest to largest.

Source

pub fn is_root(&self) -> bool

Source

pub fn is_empty(&self) -> bool

Source

pub fn iter(&self) -> Iter<'_, usize>

Source

pub fn try_get_single_entry(&self) -> Option<LV>

Source

pub fn try_get_single_entry_mut(&mut self) -> Option<&mut LV>

Source

pub fn replace(&mut self, with: &'_ [LV])

Source

pub fn debug_check_sorted(&self)

Source

pub fn advance(&mut self, graph: &Graph, range: DTRange)

Advance a frontier by the set of time spans in range

Source

pub fn advance_sparse_known_run( &mut self, graph: &Graph, parents: &[LV], range: DTRange, )

Just like advance_by_known_run, the range MUST be in a single transaction in the graph.

Source

pub fn advance_sparse(&mut self, graph: &Graph, range: DTRange)

advance_sparse is used for “sparse” causal graphs, which contain versions for other CRDTs and things. In this case, range might not directly follow the current frontier.

I think this function is equivalent to finding the dominators of self + all txns in range.

Source

pub fn advance_by_known_run(&mut self, parents: &[LV], span: DTRange)

Advance branch frontier by a transaction.

This is ONLY VALID if the range is entirely within a txn.

Source

pub fn merge_union(&mut self, other: &[LV], graph: &Graph)

Replaces self with dominators(self, other).

Source

pub fn retreat(&mut self, graph: &Graph, range: DTRange)

Source

pub fn insert(&mut self, new_item: LV)

Source

pub fn replace_with_1(&mut self, new_val: LV)

Trait Implementations§

Source§

impl AsRef<[usize]> for Frontier

Source§

fn as_ref(&self) -> &[LV]

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

impl Clone for Frontier

Source§

fn clone(&self) -> Frontier

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Frontier

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Frontier

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Frontier

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'a> From<&'a [usize]> for Frontier

Source§

fn from(f: &'a [LV]) -> Self

Converts to this type from the input type.
Source§

impl From<SmallVec<usize, 2>> for Frontier

Source§

fn from(f: SmallVec<LV, 2>) -> Self

Converts to this type from the input type.
Source§

impl From<usize> for Frontier

Source§

fn from(v: LV) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<usize> for Frontier

Source§

fn from_iter<T: IntoIterator<Item = LV>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl Index<usize> for Frontier

Source§

type Output = usize

The returned type after indexing.
Source§

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<usize> for Frontier

Source§

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl IntoIterator for Frontier

Source§

type Item = usize

The type of the elements being iterated over.
Source§

type IntoIter = <SmallVec<usize, 2> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl PartialEq for Frontier

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Frontier

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Frontier

Source§

impl StructuralPartialEq for Frontier

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,