Enum nakadion::consumer::complex_types::LogPartitionEventsMode

#[non_exhaustive]
pub enum LogPartitionEventsMode {
    Off,
    AfterConnect,
    ActivityChange,
    All,
}

Configures the logging for partition events.

A partition event occurs if a new partition is discovered for the first time on a stream (AfterConnect) or if it was deactivated or reactivated (ActivityChange) caused by PartitionInactivityTimeoutSecs.

The default is LogPartitionEventsMode::All.

Disabled log messages will still be logged at DEBUG level.

FromStr

use nakadion::consumer::LogPartitionEventsMode;

let strategy = "off".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::Off);

let strategy = "after_connect".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::AfterConnect);

let strategy = "activity_change".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::ActivityChange);

let strategy = "all".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::All);

JSON is also valid:

use nakadion::consumer::LogPartitionEventsMode;

let strategy = "\"off\"".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::Off);

let strategy = "\"after_connect\"".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::AfterConnect);

let strategy = "\"activity_change\"".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::ActivityChange);

let strategy = "\"all\"".parse::<LogPartitionEventsMode>().unwrap();
assert_eq!(strategy, LogPartitionEventsMode::All);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Off

Do not log

AfterConnect

Log partitions only when encountered the first time after a stream connect

ActivityChange

Log partitions only when inactivated or reactivated

All

Log all

Implementations

impl LogPartitionEventsMode

pub const ENV_TYPE_NAME: &'static str

The default name of the environment variable for this type. The name of the environment variable is “ LOG_PARTITION_EVENTS_MODE “

pub fn try_from_env() -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “NAKADION_ LOG_PARTITION_EVENTS_MODE “

pub fn try_from_env_prefixed<T: Into<String>>(
    prefix: T
) -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “prefix_ LOG_PARTITION_EVENTS_MODE “ The underscore and prefix will be omitted if prefix is empty.

pub fn try_from_env_named<T: AsRef<str>>(
    var_name: T
) -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is var_name.

pub fn try_from_env_type_name() -> Result<Option<Self>, Error>

Initialize from the environment. Returns None if the value was not found and fails if the value could not be parsed. The name of the environment variable is “ LOG_PARTITION_EVENTS_MODE “

pub fn from_env() -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “NAKADION_ LOG_PARTITION_EVENTS_MODE “

pub fn from_env_prefixed<T: Into<String>>(prefix: T) -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “prefix_ LOG_PARTITION_EVENTS_MODE “ The underscore and prefix will be omitted if prefix is empty.

pub fn from_env_named<T: AsRef<str>>(var_name: T) -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is var_name.

pub fn from_env_type_name() -> Result<Self, Error>

Initialize from the environment. Fails if the value was not found or if the value could not be parsed. The name of the environment variable is “ LOG_PARTITION_EVENTS_MODE “

pub fn from_env_opt() -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “NAKADION_ LOG_PARTITION_EVENTS_MODE “

pub fn from_env_opt_prefixed<T: Into<String>>(prefix: T) -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “prefix_ LOG_PARTITION_EVENTS_MODE “ The underscore and prefix will be omitted if prefix is empty.

pub fn from_env_opt_named<T: AsRef<str>>(var_name: T) -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is var_name.

pub fn from_env_opt_type_name() -> Option<Self>

Initialize from the environment. Returns None if the value could not be read for any reason. The name of the environment variable is “ LOG_PARTITION_EVENTS_MODE “

Trait Implementations

impl Clone for LogPartitionEventsMode

fn clone(&self) -> LogPartitionEventsMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LogPartitionEventsMode

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

Formats the value using the given formatter.

impl Default for LogPartitionEventsMode

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LogPartitionEventsMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for LogPartitionEventsMode

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

Formats the value using the given formatter.

impl FromStr for LogPartitionEventsMode

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq<LogPartitionEventsMode> for LogPartitionEventsMode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for LogPartitionEventsMode

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

Serialize this value into the given Serde serializer.

impl Copy for LogPartitionEventsMode

impl Eq for LogPartitionEventsMode

impl StructuralEq for LogPartitionEventsMode

impl StructuralPartialEq for LogPartitionEventsMode