Skip to main content

ConfigEntry

Struct ConfigEntry 

Source
pub struct ConfigEntry { /* private fields */ }
Expand description

A configuration entry containing name, value and additional metadata.

Corresponds to org.apache.kafka.clients.admin.ConfigEntry.

Implementations§

Source§

impl ConfigEntry

Source

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

Create a configuration entry with the provided name and value.

Corresponds to Java’s ConfigEntry(String, String) (ConfigEntry.java:44), whose parameters {name, value} are the intersection across both constructors — so it owns the plain name (CLAUDE.md §2).

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

pub fn with_options(options: ConfigEntryOptions) -> Self

Create a configuration entry with all values.

Corresponds to Java’s widest constructor (ConfigEntry.java:59). Its eight parameters exceed CLAUDE.md §2’s three-parameter cap on derived overload names, so ConfigEntryOptions is this method’s only parameter and carries all of them.

  • options - every parameter of Java’s widest constructor
Source

pub fn name(&self) -> &str

Return the config name.

Source

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

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

Source

pub fn source(&self) -> ConfigSource

Return the source of this configuration entry.

Source

pub fn is_default(&self) -> bool

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

Source

pub fn is_sensitive(&self) -> bool

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

Source

pub fn is_read_only(&self) -> bool

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

Source

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.

Source

pub fn config_type(&self) -> ConfigType

Return the config data type.

Source

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

Return the config documentation.

Trait Implementations§

Source§

impl Clone for ConfigEntry

Source§

fn clone(&self) -> ConfigEntry

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConfigEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ConfigEntry

Source§

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

Redacts sensitive value.

Source§

impl PartialEq for ConfigEntry

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for ConfigEntry

Source§

impl StructuralPartialEq for ConfigEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V