Struct Remote 

pub struct Remote { /* private fields */ }

The remote source for one configuration type, and its last document.

Remote::new() is const, so this lives in a static — which is how #[dynamic_config] emits it.

Implementations

impl Remote

pub const fn new() -> Self

An empty slot: no source, no document.

pub fn set(&self, source: impl RemoteSource)

Installs a blocking source, replacing any previous one.

The document already fetched, if any, is dropped with it — a new source answering with an old store’s values would be a puzzle nobody needs. A fetch from the previous source that is still in flight is discarded when it lands, for the same reason.

pub fn set_async(&self, source: impl AsyncRemoteSource)

Available on crate feature async only.

Installs an async source, replacing any previous one.

pub fn refresh(&self) -> Result<(), Error>

Fetches, and keeps what came back.

The network round trip happens with no lock held: a slow store cannot make load() — which reads this state for provenance — wait for it. If the source is replaced while the fetch is in flight, the result is discarded and Ok is returned: the fetch did succeed, and the new source’s own refresh is the one that matters now.

Errors

If no source is installed, if the installed one is async — use refresh_async — or if the fetch fails.

pub async fn refresh_async(&self) -> Result<(), Error>

Available on crate feature async only.

Fetches from an async source, and keeps what came back.

A blocking source is not refused — swapping one implementation for the other must not be a breaking change for the caller — but it is not run on the executor either: it goes through off_thread, so an async caller’s worker thread never sits inside a blocking network call.

The same replaced-mid-fetch rule as refresh applies, and matters more here: the unlocked window spans an await.

Errors

If no source is installed, or the fetch fails.

pub fn install(&self, document: Fetched)

Puts a document in the slot without fetching one.

What a watch loop calls: the document already arrived, pushed by the store, and re-fetching it to learn what it just said would be silly.

No source need be installed for this to work — a program that only ever watches never has to configure one. A watch loop serving a source that has since been replaced should be stopped with its RemoteWatch — this call cannot tell one store’s push from another’s.

pub fn document(&self) -> Option<Fetched>

The document last fetched, if any.

pub fn is_configured(&self) -> bool

Whether a source is installed.

pub fn describe(&self) -> Option<String>

How the installed source names itself.

pub fn clear(&self)

Drops the document, so the next load sees no remote layer.

Trait Implementations

impl Debug for Remote

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

Formats the value using the given formatter.

impl Default for Remote

fn default() -> Remote

Returns the “default value” for a type.