Struct gstreamer::DateTime

source ·

pub struct DateTime { /* private fields */ }

Expand description

Struct to store date, time and timezone information altogether. DateTime is refcounted and immutable.

Date information is handled using the proleptic Gregorian calendar.

Provides basic creation functions and accessor functions to its fields.

Implementations§

source §

impl DateTime

source

pub fn as_ptr(&self) -> *mut GstDateTime

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: const const GstDateTime ) -> &'a Self

Borrows the underlying C value.

source §

impl DateTime

source

pub fn from_g_date_time(dt: DateTime) -> DateTime

Creates a new DateTime from a glib::DateTime object.

§`dt`

the glib::DateTime.

§Returns

a newly created DateTime, or None if dt is None.

source

pub fn from_iso8601_string(string: &str) -> Result<DateTime, BoolError>

Tries to parse common variants of ISO-8601 datetime strings into a DateTime. Possible input formats are (for example): 2012-06-30T22:46:43Z, 2012, 2012-06, 2012-06-30, 2012-06-30T22:46:43-0430, 2012-06-30T22:46Z, 2012-06-30T22:46-0430, 2012-06-30 22:46, 2012-06-30 22:46:43, 2012-06-00, 2012-00-00, 2012-00-30, 22:46:43Z, 22:46Z, 22:46:43-0430, 22:46-0430, 22:46:30, 22:46 If no date is provided, it is assumed to be “today” in the timezone provided (if any), otherwise UTC.

§`string`

ISO 8601-formatted datetime string.

§Returns

a newly created DateTime, or None on error

source

pub fn from_unix_epoch_local_time(secs: i64) -> Result<DateTime, BoolError>

Creates a new DateTime using the time since Jan 1, 1970 specified by secs. The DateTime is in the local timezone.

§`secs`

seconds from the Unix epoch

§Returns

the newly created DateTime, or None on error.

source

pub fn from_unix_epoch_local_time_usecs( usecs: i64 ) -> Result<DateTime, BoolError>

Creates a new DateTime using the time since Jan 1, 1970 specified by usecs. The DateTime is in the local timezone.

§`usecs`

microseconds from the Unix epoch

§Returns

a newly created DateTime, or None on error.

source

pub fn from_unix_epoch_utc(secs: i64) -> Result<DateTime, BoolError>

Creates a new DateTime using the time since Jan 1, 1970 specified by secs. The DateTime is in the UTC timezone.

§`secs`

seconds from the Unix epoch

§Returns

the newly created DateTime, or None on error.

source

pub fn from_unix_epoch_utc_usecs(usecs: i64) -> Result<DateTime, BoolError>

Creates a new DateTime using the time since Jan 1, 1970 specified by usecs. The DateTime is in UTC.

§`usecs`

microseconds from the Unix epoch

§Returns

a newly created DateTime, or None on error.

source

pub fn new_now_local_time() -> Option<DateTime>

Creates a new DateTime representing the current date and time.

§Returns

the newly created DateTime which should be freed with gst_date_time_unref(), or None on error.

source

pub fn new_now_utc() -> Option<DateTime>

Creates a new DateTime that represents the current instant at Universal coordinated time.

§Returns

the newly created DateTime which should be freed with gst_date_time_unref(), or None on error.

source

pub fn year(&self) -> i32

Returns the year of this DateTime. Call has_year() before, to avoid warnings.

§Returns

The year of this DateTime

source

pub fn has_day(&self) -> bool

§Returns

true if self’s day field is set, otherwise false

source

pub fn has_month(&self) -> bool

§Returns

true if self’s month field is set, otherwise false

source

pub fn has_second(&self) -> bool

§Returns

true if self’s second field is set, otherwise false

source

pub fn has_time(&self) -> bool

§Returns

true if self’s hour and minute fields are set, otherwise false

source

pub fn has_year(&self) -> bool

§Returns

true if self’s year field is set (which should always be the case), otherwise false

source

pub fn to_g_date_time(&self) -> Result<DateTime, BoolError>

Creates a new glib::DateTime from a fully defined DateTime object.

§Returns

a newly created glib::DateTime, or None on error or if self does not have a year, month, day, hour, minute and second.

source

pub fn to_iso8601_string(&self) -> Result<GString, BoolError>

Create a minimal string compatible with ISO-8601. Possible output formats are (for example): 2012, 2012-06, 2012-06-23, 2012-06-23T23:30Z, 2012-06-23T23:30+0100, 2012-06-23T23:30:59Z, 2012-06-23T23:30:59+0100

§Returns

a newly allocated string formatted according to ISO 8601 and only including the datetime fields that are valid, or None in case there was an error.

source §

impl DateTime

source

pub fn new( tzoffset: impl Into<Option<f32>>, year: impl Into<i32>, month: impl Into<Option<i32>>, day: impl Into<Option<i32>>, hour: impl Into<Option<i32>>, minute: impl Into<Option<i32>>, seconds: impl Into<Option<f64>> ) -> Result<DateTime, BoolError>

Creates a new DateTime using the date and times in the gregorian calendar in the supplied timezone.

year should be from 1 to 9999, month should be from 1 to 12, day from 1 to 31, hour from 0 to 23, minutes and seconds from 0 to 59.

Note that tzoffset is a float and was chosen so for being able to handle some fractional timezones, while it still keeps the readability of representing it in hours for most timezones.

If value is -1 then all over value will be ignored. For example if month == -1, then DateTime will be created only for year. If day == -1, then DateTime will be created for year and month and so on.

§`tzoffset`

Offset from UTC in hours.

§`year`

the gregorian year

§`month`

the gregorian month

§`day`

the day of the gregorian month

§`hour`

the hour of the day

§`minute`

the minute of the hour

§`seconds`

the second of the minute

§Returns

the newly created DateTime, or None on error.

source

pub fn from_local_time( year: impl Into<i32>, month: impl Into<Option<i32>>, day: impl Into<Option<i32>>, hour: impl Into<Option<i32>>, minute: impl Into<Option<i32>>, seconds: impl Into<Option<f64>> ) -> Result<DateTime, BoolError>

source

pub fn day(&self) -> Option<i32>

Returns the day of the month of this DateTime.

§Returns

The day of this DateTime, or -1 if none is set.

source

pub fn hour(&self) -> Option<i32>

Retrieves the hour of the day represented by self in the gregorian calendar. The return is in the range of 0 to 23.

§Returns

the hour of the day, or -1 if none is set.

source

pub fn microsecond(&self) -> Option<i32>

Retrieves the fractional part of the seconds in microseconds represented by self in the gregorian calendar.

§Returns

the microsecond of the second, or -1 if none is set.

source

pub fn minute(&self) -> Option<i32>

Retrieves the minute of the hour represented by self in the gregorian calendar.

§Returns

the minute of the hour, or -1 if none is set.

source

pub fn month(&self) -> Option<i32>

Returns the month of this DateTime. January is 1, February is 2, etc..

§Returns

The month of this DateTime, or -1 if none is set.

source

pub fn second(&self) -> Option<i32>

Retrieves the second of the minute represented by self in the gregorian calendar.

§Returns

the second represented by self, or -1 if none is set.

source

pub fn time_zone_offset(&self) -> Option<f32>

Retrieves the offset from UTC in hours that the timezone specified by self represents. Timezones ahead (to the east) of UTC have positive values, timezones before (to the west) of UTC have negative values. If self represents UTC time, then the offset is zero.