Skip to main content

SyncVec

Struct SyncVec 

Source
pub struct SyncVec<V> { /* private fields */ }
Expand description

A concurrent Vec with a Go sync.Map-style read/dirty architecture:

  • read: an immutable snapshot, atomically published. get / iter read it lock-free.
  • dirty: the canonical, mutable vec, guarded by lock.

Every slot is an Arc<Entry<V>> shared between the snapshot and dirty. The entry holds an atomic pointer to the value, so set swaps the pointer in place (O(1)) — no snapshot rebuild — and readers always see the latest value. Appends are published lazily (tracked by the amended flag), while index-shifting operations (insert/remove/pop) rebuild the snapshot. Snapshots and retired values are kept alive until the vec is dropped, so references returned by get stay valid.

Implementations§

Source§

impl<V> SyncVec<V>

Source

pub fn new_arc() -> Arc<Self>

Source

pub fn new() -> Self

Source

pub fn with_capacity(capacity: usize) -> Self

Source

pub fn with_vec(vec: Vec<V>) -> Self

Source

pub fn insert(&self, index: usize, v: V) -> Option<V>

Source

pub fn set(&self, index: usize, v: V) -> Option<V>

Source

pub fn push(&self, v: V) -> Option<V>

Source

pub fn pushes(&self, arr: Vec<V>) -> Option<V>

Source

pub fn push_mut(&mut self, v: V) -> Option<V>

Source

pub fn pop(&self) -> Option<V>
where V: Clone,

Source

pub fn pop_mut(&mut self) -> Option<V>
where V: Clone,

Source

pub fn remove(&self, index: usize) -> Option<V>
where V: Clone,

Source

pub fn remove_mut(&mut self, index: usize) -> Option<V>
where V: Clone,

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn clear(&self)

Source

pub fn shrink_to_fit(&self)

Source

pub fn from(vec: Vec<V>) -> Self

Source

pub fn get(&self, index: usize) -> Option<&V>

Returns a reference to the element at index.

Reads are lock-free: the value is served from the immutable read snapshot through a shared entry, so set is visible immediately. If the index was appended to dirty since the last snapshot was published, a fresh snapshot is published first.

Source

pub unsafe fn get_uncheck(&self, index: usize) -> &V

Source

pub fn get_mut(&self, index: usize) -> Option<VecRefMut<'_, V>>
where V: Clone,

Returns a mutable handle to the element at index, implemented with copy-on-write: the value is cloned, the handle mutates the clone, and the result is swapped back into the shared entry (O(1)) when the handle is dropped. Concurrent readers may observe the pre-mutation value until the handle is dropped.

Source

pub fn contains(&self, x: &V) -> bool
where V: PartialEq,

Source

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

Iterate over the current contents. A fresh snapshot is published first, so all elements written so far are visible.

Source

pub fn iter_mut(&self) -> IterMut<'_, V>
where V: Clone,

Source

pub fn into_iter(self) -> IntoIter<V>

Source

pub fn into_inner(self) -> Vec<V>

Trait Implementations§

Source§

impl<V: Clone> Clone for SyncVec<V>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<V> Debug for SyncVec<V>
where V: Debug,

Source§

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

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

impl<V> Default for SyncVec<V>

Source§

fn default() -> Self

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

impl<'de, V> Deserialize<'de> for SyncVec<V>
where V: Deserialize<'de>,

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<V> Display for SyncVec<V>
where V: Display,

Source§

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

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

impl<V> Index<usize> for SyncVec<V>

Source§

type Output = V

The returned type after indexing.
Source§

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

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

impl<'a, V> IntoIterator for &'a SyncVec<V>

Source§

type Item = &'a V

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, V>

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<V> IntoIterator for SyncVec<V>

Source§

type Item = V

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<V>

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<V: PartialEq> PartialEq for SyncVec<V>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<V> Send for SyncVec<V>

Safety: dirty is only ever accessed under lock; the read snapshot is immutable once published; values behind entries are immutable once published and swapped out atomically; retired values and retired snapshots are kept alive until the vec is dropped, so references derived from get remain valid for the lifetime of &self.

Source§

impl<V> Serialize for SyncVec<V>
where V: Serialize,

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<V> Sync for SyncVec<V>

Auto Trait Implementations§

§

impl<V> !Freeze for SyncVec<V>

§

impl<V> !RefUnwindSafe for SyncVec<V>

§

impl<V> Unpin for SyncVec<V>
where UnsafeCell<Vec<Arc<Entry<V>>>>: Unpin, AtomicSnapshot<Vec<Arc<Entry<V>>>>: Unpin, Retired<V>: Unpin,

§

impl<V> UnsafeUnpin for SyncVec<V>
where UnsafeCell<Vec<Arc<Entry<V>>>>: UnsafeUnpin, AtomicSnapshot<Vec<Arc<Entry<V>>>>: UnsafeUnpin, Retired<V>: UnsafeUnpin,

§

impl<V> UnwindSafe for SyncVec<V>
where UnsafeCell<Vec<Arc<Entry<V>>>>: UnwindSafe, AtomicSnapshot<Vec<Arc<Entry<V>>>>: UnwindSafe, Retired<V>: UnwindSafe,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.