Struct nakadion::consumer::TickIntervalMillis

pub struct TickIntervalMillis(_);

The internal tick interval.

The applied value is always between [100..5_000] ms. When set outside of its bounds it will be adjusted to fit within the bounds.

Methods

impl TickIntervalMillis

pub fn new<T: Into<u64>>(v: T) -> Self

impl TickIntervalMillis

pub fn into_inner(self) -> u64

impl TickIntervalMillis

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_ TICK_INTERVAL_MILLIS "

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_ TICK_INTERVAL_MILLIS "

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 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_ TICK_INTERVAL_MILLIS "

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_ TICK_INTERVAL_MILLIS "

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_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_ TICK_INTERVAL_MILLIS "

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_ TICK_INTERVAL_MILLIS "

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 into_duration(self) -> Duration

impl TickIntervalMillis

pub fn adjust(self) -> TickIntervalMillis

Only 100ms up to 5_000ms allowed. We simply adjust the values because there is no reason to crash if these have been set to an out of range value.

Trait Implementations

impl Clone for TickIntervalMillis

fn clone(&self) -> TickIntervalMillis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TickIntervalMillis

impl Debug for TickIntervalMillis

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

Formats the value using the given formatter.

impl Default for TickIntervalMillis

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for TickIntervalMillis

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

Deserialize this value from the given Serde deserializer.

impl Display for TickIntervalMillis

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

Formats the value using the given formatter.

impl Eq for TickIntervalMillis

impl From<TickIntervalMillis> for u64

fn from(v: TickIntervalMillis) -> u64

Performs the conversion.

impl From<TickIntervalMillis> for Duration

fn from(v: TickIntervalMillis) -> Duration

Performs the conversion.

impl From<u64> for TickIntervalMillis

fn from(v: u64) -> TickIntervalMillis

Performs the conversion.

impl FromStr for TickIntervalMillis

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<TickIntervalMillis> for TickIntervalMillis

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

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

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

This method tests for !=.

impl Serialize for TickIntervalMillis

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

Serialize this value into the given Serde serializer.

impl StructuralEq for TickIntervalMillis

impl StructuralPartialEq for TickIntervalMillis