Struct ConfigUpdates

pub struct ConfigUpdates {
    pub updates: BTreeMap<String, ProtoConfigVal>,
}

A batch of value updates to [Config]s in a [ConfigSet].

This may be sent across processes to apply the same value updates, but may not be durably written down.

Intentionally not named with the usual Proto prefix because we pass this around directly.

Fields

updates: BTreeMap<String, ProtoConfigVal>

Implementations

impl ConfigUpdates

pub fn add<T, U>(&mut self, config: &Config<T>, val: U)

where T: ConfigDefault, U: ConfigDefault<ConfigType = T::ConfigType>,

Adds an update for the given config and value.

If a value of the same config has previously been added to these updates, replaces it.

pub fn add_dynamic(&mut self, name: &str, val: ConfigVal)

Adds an update for the given configuration name and value.

It is the callers responsibility to ensure the value is of the appropriate type for the configuration.

If a value of the same config has previously been added to these updates, replaces it.

pub fn extend(&mut self, other: Self)

Adds the entries in other to self, with other taking precedence.

pub fn apply(&self, set: &ConfigSet)

Applies these config updates to the given ConfigSet.

This doesn’t need to be the same set that the value updates were added from. In fact, the primary use of this is propagating config updates across processes.

The value updates for any configs unknown by the given set are skipped. Ditto for config type mismatches. However, this is unexpected usage at present and so is logged to Sentry.

Trait Implementations

impl Arbitrary for ConfigUpdates

type Parameters = <BTreeMap<String, ProtoConfigVal> as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<BTreeMap<String, ProtoConfigVal> as Arbitrary>::Strategy, fn(_: BTreeMap<String, ProtoConfigVal>) -> ConfigUpdates>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for ConfigUpdates

fn clone(&self) -> ConfigUpdates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigUpdates

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

Formats the value using the given formatter.

impl Default for ConfigUpdates

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConfigUpdates

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for ConfigUpdates

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ConfigUpdates

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigUpdates