Trait SyncSource

Source

pub trait SyncSource {
    // Required methods
    fn capabilities(&self) -> SourceCapabilities;
    fn enumerate(&mut self) -> Result<Vec<SourceEntry>>;
    fn fetch(&mut self, path: &str) -> Result<Option<SourceItem>>;

    // Provided methods
    fn write(&mut self, _path: &str, _content: &str) -> Result<()> { ... }
    fn remove(&mut self, _path: &str) -> Result<()> { ... }
    fn watch(&mut self) -> Result<Receiver<WatchEvent>> { ... }
    fn unwatch(&mut self) -> Result<()> { ... }
    fn close(&mut self) -> Result<()> { ... }
}

Expand description

The in-engine handle to a source.

Required Methods§

Source

fn capabilities(&self) -> SourceCapabilities

Source

fn enumerate(&mut self) -> Result<Vec<SourceEntry>>

The full current scope.

Source

fn fetch(&mut self, path: &str) -> Result<Option<SourceItem>>

One member’s current state, or None when it left the scope.

Provided Methods§

Source

fn write(&mut self, _path: &str, _content: &str) -> Result<()>

Persist engine-authored bytes (write-through sources only).

Source

fn remove(&mut self, _path: &str) -> Result<()>

Remove a member (write-through sources only).

Source

fn watch(&mut self) -> Result<Receiver<WatchEvent>>

Subscribe to the watch stream (watching sources only): one WatchEvent::Ready once the feed is primed, then one WatchEvent::Batch per batch of changed paths.

Source