Skip to main content

Replica

Struct Replica 

Source
pub struct Replica { /* private fields */ }
Expand description

One workspace root and its replica store.

Implementations§

Source§

impl Replica

Source

pub fn open(config: ReplicaConfig, clock: Arc<dyn Clock>) -> Result<Self>

Source

pub fn replica_id(&self) -> ReplicaId

Source

pub fn vv(&self) -> &VersionVector

Source

pub fn config(&self) -> &ReplicaConfig

Source

pub fn state(&self, path: &str) -> Result<Option<PathState>>

Source

pub fn states(&self) -> Result<Vec<(String, PathState)>>

Source

pub fn pause_reason(&self) -> Result<Option<PauseReason>>

Why this replica must not scan or apply right now. A root or marker that is missing while files were written would otherwise read as “everything deleted”.

Source

pub fn scan(&mut self) -> Result<ScanOutcome>

Record every unrecorded edit under the root and finish pending writes.

Source

pub fn delta_for(&self, peer: &VersionVector) -> Result<Vec<PathUpdate>>

Path states the peer with version vector peer has not merged.

Source

pub fn apply( &mut self, updates: &[PathUpdate], source: &dyn ContentSource, ) -> Result<Report>

Join updates received from a peer, fetching content from source.

Every update is joined before any file is written, so that the joined states go to the store in one transaction and what the files then hold in another, rather than several transactions per path.

Source

pub fn commit_session(&mut self, peer: &VersionVector) -> Result<()>

Declare that every update of a session with peer has been applied.

Source

pub fn fetch_missing(&mut self, source: &dyn ContentSource) -> Result<Report>

Retry writes that were waiting for content.

Source

pub fn unavailable(&self) -> Result<Vec<ContentHash>>

Content this replica wants written and does not have: the winner of a path whose file does not hold it yet, and each loser still waiting for its conflict copy.

A session asks its peer for these whatever the peer sends: committing a session takes in the peer’s version vector even when some content never arrived, so no later delta carries those paths again. Content the replica would not write anyway — an ignored or unrepresentable path, a case collision, a file over the size limit — is left out.

Source

pub fn collect_staging(&self) -> Result<usize>

Remove staged content nothing needs any more, returning how many files went.

Staged content is kept while some stored version refers to it and no workspace file holds it: the replica may still write it, or be asked for it. Placing content moves it out of staging, so what this removes is content staged and never placed — a version superseded first, a second copy from another session, inline content of a page that never came. A workspace file counts as holding the content only when its recorded stamp still matches and is not racy; nothing is re-hashed here.

Files younger than [STAGING_GRACE] are kept whatever they hold: a session stages inline content before the page that refers to it arrives, and runs alongside this.

Source

pub fn stager(&self) -> Stager

A Stager over this replica’s staging directory and size limit.

Source

pub fn content_path(&self, hash: &ContentHash) -> Result<Option<(PathBuf, u64)>>

A file holding the content hash, and its length: a synced file on disk, else finished staged content. A file whose length and mtime still match what was recorded (and are not racy) is trusted; any other is re-hashed first.

Source

pub fn content_paths( &self, hashes: &[ContentHash], ) -> Result<HashMap<ContentHash, (PathBuf, u64)>>

Self::content_path for each of hashes, building the store index once for all of them rather than once per hash. A hash no file or staged content holds is left out of the map.

Trait Implementations§

Source§

impl ContentSource for Replica

Source§

fn locate(&self, hash: &ContentHash) -> Option<PathBuf>

A file holding exactly the content hash, if there is one. The replica copies it through a verifying staging writer, so a wrong file is refused, not trusted.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more