Struct ChangeOrigin 

pub struct ChangeOrigin {
    pub action: Option<String>,
    pub principal: Option<String>,
}

Who and what made a settings change: the action (or shell entry point, such as a fixed chord) that caused it, and the principal that invoked it.

A source that keeps a history ([crate::SessionSettings]) records it beside each changed leaf, so “who changed this” has an answer and a later system undo has its input. Both fields are optional: a write another process made to the copy arrives with no origin at all.

Fields

action: Option<String>

The action id (appearance.theme.dark) or shell entry point (fixed-toggle-mouse-keys) that made the change.

principal: Option<String>

Who invoked it: ChangeOrigin::LOCAL_USER for the person at this device’s own input, else the collaborator’s or agent’s principal.

Implementations

impl ChangeOrigin

pub const LOCAL_USER: &'static str = "local-user"

The person at this device’s keyboard, pointer or touch screen.

pub fn action(action: impl Into<String>) -> ChangeOrigin

A change action made, with no principal known yet.

pub fn by(self, principal: impl Into<String>) -> ChangeOrigin

This origin, invoked by principal.

pub fn local(action: impl Into<String>) -> ChangeOrigin

action, invoked by the person at this device’s own input.

Trait Implementations

impl Clone for ChangeOrigin

fn clone(&self) -> ChangeOrigin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeOrigin

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

Formats the value using the given formatter.

impl Default for ChangeOrigin

fn default() -> ChangeOrigin

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChangeOrigin

fn deserialize<__D>( __deserializer: __D, ) -> Result<ChangeOrigin, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChangeOrigin

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChangeOrigin

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ChangeOrigin

impl StructuralPartialEq for ChangeOrigin