Struct Duration

pub struct Duration { /* private fields */ }

A Kubernetes duration.

This is equivalent to the metav1.Duration type in the Go Kubernetes apimachinery package. A metav1.Duration is serialized in YAML and JSON as a string formatted in the format accepted by the Go standard library’s time.ParseDuration() function. This type is a similar wrapper around Rust’s std::time::Duration that can be serialized and deserialized using the same format as metav1.Duration.

On Signedness

Go’s time.Duration type is a signed integer type, while Rust’s std::time::Duration is unsigned. Therefore, this type is also capable of representing both positive and negative durations. This is implemented by storing whether or not the parsed duration was negative as a boolean field in the wrapper type. The Duration::is_negative method returns this value, and when a Duration is serialized, the negative sign is included if the duration is negative.

Durations can be compared with std::time::Durations. If the Duration is negative, it will always be considered less than the std::time::Duration. Similarly, because std::time::Durations are unsigned, a negative Duration will never be equal to a std::time::Duration, even if the wrapped std::time::Duration (the negative duration’s absolute value) is equal.

When converting a Duration into a std::time::Duration, be aware that this information is lost: if a negative Duration is converted into a std::time::Duration and then that std::time::Duration is converted back into a Duration, the second Duration will not be negative.

Implementations

impl Duration

pub fn is_negative(&self) -> bool

Returns true if this Duration is negative.

Trait Implementations

impl Clone for Duration

fn clone(&self) -> Duration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Duration

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Duration

fn deserialize<D>( deserializer: D, ) -> Result<Duration, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Duration

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

Formats the value using the given formatter.

impl From<Duration> for Duration

fn from(duration: Duration) -> Duration

Converts to this type from the input type.

impl FromStr for Duration

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Duration, <Duration as FromStr>::Err>

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

impl JsonSchema for Duration

fn schema_name() -> String

The name of the generated JSON Schema.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn json_schema(_: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Duration

fn cmp(&self, other: &Duration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Duration> for &Duration

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

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

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

fn partial_cmp(&self, other: &Duration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd for Duration

fn partial_cmp(&self, other: &Duration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Duration

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Duration

impl Eq for Duration

impl StructuralPartialEq for Duration