Struct ChannelSettings 

pub struct ChannelSettings { /* private fields */ }

The settings source a launched app reads through its channel.

Implementations

impl ChannelSettings

pub fn new(app_id: &str) -> ChannelSettings

pub fn linked(&self)

A new link to the shell: its revisions start again.

pub fn disconnected(&self)

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

pub fn dictionary_edit(&self, revision: u64, edit: Edit) -> Result<(), Error>

pub fn received(&self, revision: u64, view: Map<String, Value>) -> bool

The shell’s view at revision arrived or changed. Returns whether what this process reads changed.

pub fn take_outbox(&self) -> Vec<(String, Map<String, Value>, Option<String>)>

Writes for the worker to send, in order; each is answered with Self::answered.

pub fn answered( &self, answer: Result<(u64, Map<String, Value>), String>, ) -> bool

The shell’s answer to one sent write: the view after it, or why it was refused. Returns whether what this process reads changed.

Trait Implementations

impl SettingsSource for ChannelSettings

fn load(&self) -> Map<String, Value>

The whole document. Forgiving like the file: never fails.

fn take_deferred_failures(&self) -> Vec<DeferredFailure>

The failures of writes this source accepted before they were made durable, each once, oldest first: the changes were reverted in the document.

fn update_section( &self, name: &str, values: Map<String, Value>, ) -> Result<(), Error>

Merge values into section name as [crate::update_section] does.

fn update_section_by( &self, name: &str, values: Map<String, Value>, origin: &ChangeOrigin, ) -> Result<(), Error>

[Self::update_section], recording origin with every leaf it changes. A source without a history ignores the origin.

fn revision(&self) -> u64

Changes whenever the document does, so readers can cache it.

fn changes(&self) -> &ChangeSignal

Rings every time [Self::revision] changes, so a reader waiting for a change wakes at once instead of looking again and again.

fn update_section_with( &self, name: &str, origin: &ChangeOrigin, change: &mut dyn FnMut(&Map<String, Value>) -> Map<String, Value>, ) -> Result<(), Error>

Read section name and merge what change makes of it, recording origin, as one step no other write to this source lands inside. This is the read-modify-write behind [crate::Key::update]: a toggle pressed twice in quick succession flips twice.

fn flush_pending(&self)

Wait until every change this source accepted is durable. Sources whose writes are durable when they return have nothing to do.

fn compare_update_section( &self, _name: &str, _expected: &Map<String, Value>, _values: Map<String, Value>, ) -> Result<ConditionalUpdate, Error>

Merge only if the current section still equals expected, under the same lock that protects persistence and external-write adoption. Superseded means a newer document replaced the caller’s intent.

fn compare_display_update( &self, _update: DisplayUpdate, ) -> Result<ConditionalUpdate, Error>

Atomically compare and merge display transaction/profile intent in its single device record.

fn compare_display_transaction( &self, expected: Option<&Value>, transaction: Map<String, Value>, ) -> Result<(), Error>

Compare a host-owned display transaction, including an absent section. Main’s atomic display update also protects the observed profile state.

fn store(&self) -> Option<&Store>

The profile’s documents themselves, where this source is them: what a change that needs the document’s history (a section’s undo) is made through. None for a source that keeps only the values (an app’s channel to the session’s settings).

fn dictionary_service(&self) -> Option<Arc<Service>>

Host-owned personal vocabulary. App/profile sources provide no host authority; the authenticated settings capability projects scoped reads.