Struct AlterConsumer

pub struct AlterConsumer {
    pub name: String,
    pub set_important: Option<bool>,
    pub set_read_from: Option<Timestamp>,
    pub set_supported_codecs: Option<SupportedCodecs>,
    pub alter_attributes: HashMap<String, String>,
}

Consumer alter description.

Fields

name: String

Must have valid not empty name as a key.

set_important: Option<bool>

Consumer may be marked as ‘important’. It means messages for this consumer will never expire due to retention. User should take care that such consumer never stalls, to prevent running out of disk space. Flag that this consumer is important.

set_read_from: Option<Timestamp>

All messages with smaller server written_at timestamp will be skipped.

set_supported_codecs: Option<SupportedCodecs>

List of supported codecs by this consumer. supported_codecs on topic must be contained inside this list. If empty, codec compatibility check for the consumer is disabled.

alter_attributes: HashMap<String, String>

User and server attributes of consumer. Server attributes starts from “_” and will be validated by server. Leave the value blank to drop an attribute.

Implementations

impl AlterConsumer

pub fn set_important(&self) -> bool

Returns the value of set_important, or the default value if set_important is unset.

Trait Implementations

impl Clone for AlterConsumer

fn clone(&self) -> AlterConsumer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlterConsumer

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

Formats the value using the given formatter.

impl Default for AlterConsumer

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AlterConsumer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for AlterConsumer

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for AlterConsumer

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

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 AlterConsumer