Struct sqlx_mysql::types::MySqlTime

pub struct MySqlTime { /* private fields */ }

Container for a MySQL TIME value, which may be an interval or a time-of-day.

Allowed range is -838:59:59.0 to 838:59:59.0.

If this value is used for a time-of-day, the range should be 00:00:00.0 to 23:59:59.999999. You can use Self::is_valid_time_of_day() to check this easily.

• MySQL Manual 13.2.3: The TIME Type
• MariaDB Manual: TIME

Implementations

impl MySqlTime

pub const ZERO: Self = _

The MySqlTime value corresponding to TIME '0:00:00.0' (zero).

pub const MAX: Self = _

The MySqlTime value corresponding to TIME '838:59:59.0' (max value).

pub const MIN: Self = _

The MySqlTime value corresponding to TIME '-838:59:59.0' (min value).

pub fn new( sign: MySqlTimeSign, hours: u32, minutes: u8, seconds: u8, microseconds: u32, ) -> Result<Self, MySqlTimeError>

Construct a MySqlTime that is valid for use as a TIME value.

Errors

• MySqlTimeError::NegativeZero if all fields are 0 but sign is MySqlTimeSign::Negative.
• MySqlTimeError::FieldRange if any field is out of range:
  • hours > 838
  • minutes > 59
  • seconds > 59
  • microseconds > 999_999
• MySqlTimeError::SubsecondExcess if the magnitude is less than one second over the maximum.
  • Durations 839 hours or greater are covered by FieldRange.

pub fn with_sign(self, sign: MySqlTimeSign) -> Self

Update the sign of this value.

pub fn sign(&self) -> MySqlTimeSign

Return the sign (positive or negative) for this TIME value.

pub fn is_zero(&self) -> bool

Returns true if self is zero (equal to Self::ZERO).

pub fn is_positive(&self) -> bool

Returns true if self is positive or zero, false if negative.

pub fn is_negative(&self) -> bool

Returns true if self is negative, false if positive or zero.

pub fn is_valid_time_of_day(&self) -> bool

Returns true if this interval is a valid time-of-day.

If true, the sign is positive and hours is not greater than 23.

pub fn hours(&self) -> u32

Get the total number of hours in this interval, from 0 to 838.

If this value represents a time-of-day, the range is 0 to 23.

pub fn minutes(&self) -> u8

Get the number of minutes in this interval, from 0 to 59.

pub fn seconds(&self) -> u8

Get the number of seconds in this interval, from 0 to 59.

pub fn microseconds(&self) -> u32

Get the number of seconds in this interval, from 0 to 999,999.

pub fn to_duration(&self) -> Option<Duration>

Convert this TIME value to a std::time::Duration.

Returns None if this value is negative (cannot be represented).

Trait Implementations

impl Clone for MySqlTime

fn clone(&self) -> MySqlTime

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MySqlTime

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

Formats the value using the given formatter.

impl<'r> Decode<'r, MySql> for MySqlTime

fn decode(value: <MySql as Database>::ValueRef<'r>) -> Result<Self, BoxDynError>

Decode a new value of this type using a raw value from the database.

impl Display for MySqlTime

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

Formats the value using the given formatter.

impl<'q> Encode<'q, MySql> for MySqlTime

fn encode_by_ref( &self, buf: &mut <MySql as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, BoxDynError>

Writes the value of self into buf without moving self.

fn size_hint(&self) -> usize

fn encode( self, buf: &mut <DB as Database>::ArgumentBuffer<'q>, ) -> Result<IsNull, Box<dyn Error + Sync + Send>>

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

impl Ord for MySqlTime

fn cmp(&self, other: &Self) -> 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 PartialEq for MySqlTime

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

fn partial_cmp(&self, other: &MySqlTime) -> 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 TryFrom<Duration> for MySqlTime

Convert MySqlTime from std::time::Duration.

Note: Precision Truncation

Duration supports nanosecond precision, but MySQL TIME values only support microsecond precision.

For simplicity, higher precision values are truncated when converting. If you prefer another rounding mode instead, you should apply that to the Duration first.

See also: MySQL Manual, section 13.2.6: Fractional Seconds in Time Values

Errors:

Returns MySqlTimeError::FieldRange if the given duration is longer than 838:59:59.999999.

type Error = MySqlTimeError

The type returned in the event of a conversion error.

fn try_from(value: Duration) -> Result<Self, Self::Error>

Performs the conversion.

impl Type<MySql> for MySqlTime

fn type_info() -> MySqlTypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for MySqlTime

impl Eq for MySqlTime

impl StructuralPartialEq for MySqlTime