Enum CleanupPolicy 

pub enum CleanupPolicy {
    Delete,
    Compact,
    CompactAndDelete,
    NoCleanup,
}

Per-topic policy for what to do with old log segments.

Kafka’s cleanup.policy is a list, and LogConfig derives two independent booleans from it: compact when the list contains compact and delete when it contains delete. The four sets an operator can write are the four variants here.

Delete is the default. It deletes segments by age or by size in crate::retention. Compact does newest-wins dedup by key. crate::compact implements it, and crate::Log::compact invokes it. CompactAndDelete is Kafka’s compact,delete: the log cleaner runs over it and retention deletes its old segments. Kafka Streams writes exactly that value on every windowed-store changelog topic, so a broker that refuses it cannot host a Streams application with a windowed store. NoCleanup is the empty list, which Kafka accepts and documents as infinite retention: neither the cleaner nor time and size retention runs.

Ask Self::contains_compact and Self::contains_delete rather than comparing variants: Compact and CompactAndDelete both run the cleaner.

as_str is the cleanup.policy value Kafka reports for the policy, which is what DescribeConfigs echoes back.

Variants

Delete

Compact

CompactAndDelete

NoCleanup

Implementations

impl CleanupPolicy

pub const fn as_str(self) -> &'static str

The text this variant stands for.

impl CleanupPolicy

pub const fn contains_compact(self) -> bool

true when the policy list contains compact, which is what makes a partition the log cleaner’s work.

pub const fn contains_delete(self) -> bool

true when the policy list contains delete, which is what makes a partition’s old segments eligible for time-, size- and start-offset-based retention.

Trait Implementations

impl Clone for CleanupPolicy

fn clone(&self) -> CleanupPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CleanupPolicy

impl Debug for CleanupPolicy

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

Formats the value using the given formatter.

impl Default for CleanupPolicy

fn default() -> CleanupPolicy

Returns the “default value” for a type.

impl Eq for CleanupPolicy

impl PartialEq for CleanupPolicy

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CleanupPolicy