Struct Params

pub struct Params {
    inner: BTreeMap<Param, String>,
}

An object for handling key=value parameter lists.

The structure is serialized by calling to_string() on it.

Only for library-internal use.

Fields

inner: BTreeMap<Param, String>

Implementations

impl Params

pub fn new() -> Self

Create new empty params.

pub fn get(&self, key: Param) -> Option<&str>

Get the value of the given key, return None if no value is set.

pub fn exists(&self, key: Param) -> bool

Check if the given key is set.

pub fn set(&mut self, key: Param, value: impl ToString) -> &mut Self

Set the given key to the passed in value.

pub fn remove(&mut self, key: Param) -> &mut Self

Removes the given key, if it exists.

pub fn set_optional( &mut self, key: Param, value: Option<impl ToString>, ) -> &mut Self

Sets the given key from an optional value. Removes the key if the value is None.

pub fn is_empty(&self) -> bool

Check if there are any values in this.

pub fn len(&self) -> usize

Returns how many key-value pairs are set.

pub fn get_int(&self, key: Param) -> Option<i32>

Get the given parameter and parse as i32.

pub fn get_i64(&self, key: Param) -> Option<i64>

Get the given parameter and parse as i64.

pub fn get_bool(&self, key: Param) -> Option<bool>

Get the given parameter and parse as bool.

pub fn get_cmd(&self) -> SystemMessage

Get the parameter behind Param::Cmd interpreted as SystemMessage.

pub fn set_cmd(&mut self, value: SystemMessage)

Set the parameter behind Param::Cmd.

pub fn get_float(&self, key: Param) -> Option<f64>

Get the given parameter and parse as f64.

pub fn get_file<'a>( &self, key: Param, context: &'a Context, ) -> Result<Option<ParamsFile<'a>>>

Gets the given parameter and parse as ParamsFile.

See also Params::get_blob and Params::get_path which may be more convenient.

pub async fn get_blob<'a>( &self, key: Param, context: &'a Context, ) -> Result<Option<BlobObject<'a>>>

Gets the parameter and returns a BlobObject for it.

This parses the parameter value as a ParamsFile and than tries to return a BlobObject for that file. If the file is not yet a valid blob, one will be created by copying the file.

Note that in the ParamsFile::FsPath case the blob can be created without copying if the path already refers to a valid blob. If so a BlobObject will be returned.

pub fn get_path(&self, key: Param, context: &Context) -> Result<Option<PathBuf>>

Gets the parameter and returns a PathBuf for it.

This parses the parameter value as a ParamsFile and returns a PathBuf to the file.

pub fn set_int(&mut self, key: Param, value: i32) -> &mut Self

Set the given parameter to the passed in i32.

pub fn set_i64(&mut self, key: Param, value: i64) -> &mut Self

Set the given parameter to the passed in i64.

pub fn set_float(&mut self, key: Param, value: f64) -> &mut Self

Set the given parameter to the passed in f64 .

impl Params

pub(crate) fn update_timestamp( &mut self, scope: Param, new_timestamp: i64, ) -> Result<bool>

Updates a param’s timestamp in memory, if reasonable. Returns true if the caller shall update the settings belonging to the scope.

Trait Implementations

impl Clone for Params

fn clone(&self) -> Params

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Params

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

Formats the value using the given formatter.

impl Default for Params

fn default() -> Params

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Params

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Params

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

Formats the value using the given formatter.

impl FromStr for Params

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a raw string to Param.

Silently ignore unknown keys: they may come from a downgrade (when a shortly new version adds a key) or from an upgrade (when a key is dropped but was used in the past)

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq for Params

fn eq(&self, other: &Params) -> 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 Params

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Params

impl StructuralPartialEq for Params