Struct ConfigEntry 

pub struct ConfigEntry { /* private fields */ }

A class representing a configuration entry containing name, value and additional metadata.

Translation notes

Debug renders what Display renders.

Implementations

impl ConfigEntry

pub fn new(name: String, value: Option<String>) -> Self

Create a configuration entry with the provided values.

Arguments

• name - the non-None config name
• value - the config value or None

pub fn with_options(options: ConfigEntryOptions) -> Self

Create a configuration with the provided values.

Arguments

• options - the parameters of Java’s widest constructor: name, value, source, is_sensitive, is_read_only, synonyms, config_type and documentation

pub fn name(&self) -> &str

Returns the config name.

pub fn value(&self) -> Option<&str>

Returns the value or None. None is returned if the config is unset or if is_sensitive is true.

pub fn source(&self) -> ConfigSource

Returns the source of this configuration entry.

pub fn is_default(&self) -> bool

Returns whether the config value is the default or if it’s been explicitly set.

pub fn is_sensitive(&self) -> bool

Returns whether the config value is sensitive. The value is always set to None by the broker if the config value is sensitive.

pub fn is_read_only(&self) -> bool

Returns whether the config is read-only and cannot be updated.

pub fn synonyms(&self) -> &[ConfigSynonym]

Returns all config values that may be used as the value of this config along with their source, in the order of precedence. The list starts with the value returned in this ConfigEntry. The list is empty if synonyms were not requested.

pub fn type(&self) -> Option<ConfigType>

Returns the config data type.

pub fn documentation(&self) -> Option<&str>

Returns the config documentation.

Trait Implementations

impl Clone for ConfigEntry

fn clone(&self) -> ConfigEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigEntry

Renders exactly what the redacting Display renders.

Java has a single toString(), which prints Redacted for the value of a sensitive entry; a derived Debug would be a second, unredacted rendering. Config and AlterConfigOp embed entries, so their derived Debug renders through this one.

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

Formats the value using the given formatter.

impl Display for ConfigEntry

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

Redacts sensitive value.

Java’s toString(): the source and type render as their Java constant names (a missing type as null), and the synonyms as Java’s AbstractCollection.toString() renders the list ([a, b], [] when empty), each synonym through its own Display.

impl Hash for ConfigEntry

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ConfigEntry

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

impl StructuralPartialEq for ConfigEntry