Struct bonsaidb::core::key::time::limited::LimitedResolutionDuration

pub struct LimitedResolutionDuration<Resolution>
where
    Resolution: TimeResolution,
{ /* private fields */ }

A Duration of time stored with a limited Resolution. This type may be preferred to std::time::Duration because Duration takes a full 12 bytes to achieve its nanosecond resolution.

Converting from Duration truncates the duration and performs no rounding.

The Resolution type controls the storage size. The resolutions provided by BonsaiDb:

• Weeks
• Days
• Hours
• Minutes
• Seconds
• Milliseconds
• Microseconds
• Nanoseconds

Other resolutions can be used by implementing TimeResolution.

Implementations

impl<Resolution> LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

pub const fn new( representation: <Resolution as TimeResolution>::Representation ) -> LimitedResolutionDuration<Resolution>

Returns a new instance with the representation provided, which conceptually is a unit of Resolution.

pub const fn representation( &self ) -> <Resolution as TimeResolution>::Representation

Returns the internal representation of this duration.

Trait Implementations

impl<Resolution> Clone for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn clone(&self) -> LimitedResolutionDuration<Resolution>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Resolution> Debug for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

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

Formats the value using the given formatter.

impl<Resolution> Default for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn default() -> LimitedResolutionDuration<Resolution>

Returns the “default value” for a type.

impl<'de, Resolution> Deserialize<'de> for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Resolution> Display for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

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

Formats the value using the given formatter.

impl<Resolution, Epoch> From<LimitedResolutionDuration<Resolution>> for LimitedResolutionTimestamp<Resolution, Epoch>

where Resolution: TimeResolution, Epoch: TimeEpoch,

fn from( duration: LimitedResolutionDuration<Resolution> ) -> LimitedResolutionTimestamp<Resolution, Epoch>

Converts to this type from the input type.

impl<Resolution, Epoch> From<LimitedResolutionTimestamp<Resolution, Epoch>> for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution, Epoch: TimeEpoch,

fn from( time: LimitedResolutionTimestamp<Resolution, Epoch> ) -> LimitedResolutionDuration<Resolution>

Converts to this type from the input type.

impl<Resolution> Hash for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn hash<__H>(&self, __state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'k, Resolution> Key<'k> for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

const CAN_OWN_BYTES: bool = false

If true, this type can benefit from an owned Vec<u8>. This flag is used as a hint of whether to attempt to do memcpy operations in some decoding operations to avoid extra allocations.

fn from_ord_bytes<'e>( bytes: ByteSource<'k, 'e> ) -> Result<LimitedResolutionDuration<Resolution>, <LimitedResolutionDuration<Resolution> as KeyEncoding>::Error>

Deserialize a sequence of bytes previously encoded with KeyEncoding::as_ord_bytes.

fn first_value() -> Result<Self, NextValueError>

Return the first value in sequence for this type. Not all types implement this.

fn next_value(&self) -> Result<Self, NextValueError>

Return the next value in sequence for this type. Not all types implement this. Instead of wrapping/overflowing, None should be returned.

impl<Resolution> KeyEncoding for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

type Error = TimeError

The error type that can be produced by either serialization or deserialization.

const LENGTH: Option<usize> = None

The size of the key, if constant. If this type doesn’t produce the same number of bytes for each value, this should be None.

fn describe<Visitor>(visitor: &mut Visitor)

where Visitor: KeyVisitor,

Describes this type by invoking functions on visitor describing the key being encoded.

fn as_ord_bytes( &self ) -> Result<Cow<'_, [u8]>, <LimitedResolutionDuration<Resolution> as KeyEncoding>::Error>

Convert self into a Cow<'_, [u8]> containing bytes that are able to be compared via memcmp in a way that is comptaible with its own Ord implementation.

impl<Resolution> Ord for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn cmp(&self, __other: &LimitedResolutionDuration<Resolution>) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<Resolution> PartialEq for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn eq(&self, __other: &LimitedResolutionDuration<Resolution>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Resolution> PartialOrd for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn partial_cmp( &self, __other: &LimitedResolutionDuration<Resolution> ) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<Resolution> Serialize for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

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<Resolution> Sum<LimitedResolutionDuration<Resolution>> for Option<LimitedResolutionDuration<Resolution>>

where Resolution: TimeResolution,

fn sum<I>(iter: I) -> Option<LimitedResolutionDuration<Resolution>>

where I: Iterator<Item = LimitedResolutionDuration<Resolution>>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<Resolution> Sum for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

fn sum<I>(iter: I) -> LimitedResolutionDuration<Resolution>

where I: Iterator<Item = LimitedResolutionDuration<Resolution>>,

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<Resolution> TryFrom<Duration> for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from( duration: Duration ) -> Result<LimitedResolutionDuration<Resolution>, <LimitedResolutionDuration<Resolution> as TryFrom<Duration>>::Error>

Performs the conversion.

impl<Resolution> TryFrom<LimitedResolutionDuration<Resolution>> for Duration

where Resolution: TimeResolution,

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from( value: LimitedResolutionDuration<Resolution> ) -> Result<Duration, <Duration as TryFrom<LimitedResolutionDuration<Resolution>>>::Error>

Performs the conversion.

impl<Resolution> TryFrom<LimitedResolutionDuration<Resolution>> for SignedDuration

where Resolution: TimeResolution,

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from( value: LimitedResolutionDuration<Resolution> ) -> Result<SignedDuration, <SignedDuration as TryFrom<LimitedResolutionDuration<Resolution>>>::Error>

Performs the conversion.

impl<Resolution> TryFrom<SignedDuration> for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

type Error = TimeError

The type returned in the event of a conversion error.

fn try_from( duration: SignedDuration ) -> Result<LimitedResolutionDuration<Resolution>, <LimitedResolutionDuration<Resolution> as TryFrom<SignedDuration>>::Error>

Performs the conversion.

impl<Resolution> Copy for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,

impl<Resolution> Eq for LimitedResolutionDuration<Resolution>

where Resolution: TimeResolution,