Struct UserSettings

pub struct UserSettings { /* private fields */ }

Implementations

impl UserSettings

pub const USER_NAME_PLACEHOLDER: &'static str = "(no name configured)"

pub const USER_EMAIL_PLACEHOLDER: &'static str = "(no email configured)"

pub fn from_config(config: StackedConfig) -> Result<Self, ConfigGetError>

pub fn with_new_config( &self, config: StackedConfig, ) -> Result<Self, ConfigGetError>

Like UserSettings::from_config(), but retains the internal state.

This ensures that no duplicated change IDs are generated within the current process. New debug.randomness-seed value is ignored.

pub fn get_rng(&self) -> Arc<JJRng>

pub fn user_name(&self) -> &str

pub fn user_email(&self) -> &str

pub fn fsmonitor_settings(&self) -> Result<FsmonitorSettings, ConfigGetError>

pub fn commit_timestamp(&self) -> Option<Timestamp>

pub fn operation_timestamp(&self) -> Option<Timestamp>

pub fn operation_hostname(&self) -> &str

pub fn operation_username(&self) -> &str

pub fn signature(&self) -> Signature

pub fn config(&self) -> &StackedConfig

Returns low-level config object.

You should typically use settings.get_<type>() methods instead.

pub fn git_settings(&self) -> Result<GitSettings, ConfigGetError>

pub fn signing_backend(&self) -> Result<Option<String>, ConfigGetError>

pub fn sign_settings(&self) -> SignSettings

impl UserSettings

General-purpose accessors.

pub fn get<'de, T: Deserialize<'de>>( &self, name: impl ToConfigNamePath, ) -> Result<T, ConfigGetError>

Looks up value of the specified type T by name.

pub fn get_string( &self, name: impl ToConfigNamePath, ) -> Result<String, ConfigGetError>

Looks up string value by name.

pub fn get_int( &self, name: impl ToConfigNamePath, ) -> Result<i64, ConfigGetError>

Looks up integer value by name.

pub fn get_bool( &self, name: impl ToConfigNamePath, ) -> Result<bool, ConfigGetError>

Looks up boolean value by name.

pub fn get_value( &self, name: impl ToConfigNamePath, ) -> Result<ConfigValue, ConfigGetError>

Looks up generic value by name.

pub fn get_value_with<T, E: Into<Box<dyn Error + Send + Sync>>>( &self, name: impl ToConfigNamePath, convert: impl FnOnce(ConfigValue) -> Result<T, E>, ) -> Result<T, ConfigGetError>

Looks up value by name, converts it by using the given function.

pub fn get_table( &self, name: impl ToConfigNamePath, ) -> Result<ConfigTable, ConfigGetError>

Looks up sub table by name.

Use table_keys(prefix) and get([prefix, key]) instead if table values have to be converted to non-generic value type.

pub fn table_keys( &self, name: impl ToConfigNamePath, ) -> impl Iterator<Item = &str>

Returns iterator over sub table keys at name.

Trait Implementations

impl Clone for UserSettings

fn clone(&self) -> UserSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserSettings

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

Formats the value using the given formatter.