Struct gstreamer::DateTime [−]
pub struct DateTime(_);
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.
Methods
impl DateTime
[src]
impl DateTime
pub fn new(
tzoffset: f32,
year: i32,
month: i32,
day: i32,
hour: i32,
minute: i32,
seconds: f64
) -> DateTime
[src]
pub fn new(
tzoffset: f32,
year: i32,
month: i32,
day: i32,
hour: i32,
minute: i32,
seconds: f64
) -> DateTime
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 created only for year
. If
day
== -1, then DateTime
will created for year
and month
and
so on.
Free-function: gst_date_time_unref
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
pub fn new_from_g_date_time(dt: &DateTime) -> DateTime
[src]
pub fn new_from_g_date_time(dt: &DateTime) -> DateTime
Creates a new DateTime
from a glib::DateTime
object.
Free-function: gst_date_time_unref
dt
the glib::DateTime
. The new DateTime
takes ownership.
Returns
a newly created DateTime
,
or None
on error
pub fn new_from_iso8601_string(string: &str) -> DateTime
[src]
pub fn new_from_iso8601_string(string: &str) -> DateTime
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.
Free-function: gst_date_time_unref
string
ISO 8601-formatted datetime string.
Returns
a newly created DateTime
,
or None
on error
pub fn new_from_unix_epoch_local_time(secs: i64) -> DateTime
[src]
pub fn new_from_unix_epoch_local_time(secs: i64) -> DateTime
Creates a new DateTime
using the time since Jan 1, 1970 specified by
secs
. The DateTime
is in the local timezone.
Free-function: gst_date_time_unref
secs
seconds from the Unix epoch
Returns
the newly created DateTime
pub fn new_from_unix_epoch_utc(secs: i64) -> DateTime
[src]
pub fn new_from_unix_epoch_utc(secs: i64) -> DateTime
Creates a new DateTime
using the time since Jan 1, 1970 specified by
secs
. The DateTime
is in the UTC timezone.
Free-function: gst_date_time_unref
secs
seconds from the Unix epoch
Returns
the newly created DateTime
pub fn new_local_time(
year: i32,
month: i32,
day: i32,
hour: i32,
minute: i32,
seconds: f64
) -> DateTime
[src]
pub fn new_local_time(
year: i32,
month: i32,
day: i32,
hour: i32,
minute: i32,
seconds: f64
) -> DateTime
Creates a new DateTime
using the date and times in the gregorian calendar
in the local 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.
If month
is -1, then the DateTime
created will only contain year
,
and all other fields will be considered not set.
If day
is -1, then the DateTime
created will only contain year
and
month
and all other fields will be considered not set.
If hour
is -1, then the DateTime
created will only contain year
and
month
and day
, and the time fields will be considered not set. In this
case minute
and seconds
should also be -1.
Free-function: gst_date_time_unref
year
the gregorian year
month
the gregorian month, or -1
day
the day of the gregorian month, or -1
hour
the hour of the day, or -1
minute
the minute of the hour, or -1
seconds
the second of the minute, or -1
Returns
the newly created DateTime
pub fn new_now_local_time() -> DateTime
[src]
pub fn new_now_local_time() -> DateTime
Creates a new DateTime
representing the current date and time.
Free-function: gst_date_time_unref
Returns
the newly created DateTime
which should
be freed with DateTime::unref
.
pub fn new_now_utc() -> DateTime
[src]
pub fn new_now_utc() -> DateTime
Creates a new DateTime
that represents the current instant at Universal
coordinated time.
Free-function: gst_date_time_unref
Returns
the newly created DateTime
which should
be freed with DateTime::unref
.
pub fn new_y(year: i32) -> DateTime
[src]
pub fn new_y(year: i32) -> DateTime
Creates a new DateTime
using the date and times in the gregorian calendar
in the local timezone.
year
should be from 1 to 9999.
Free-function: gst_date_time_unref
year
the gregorian year
Returns
the newly created DateTime
pub fn new_ym(year: i32, month: i32) -> DateTime
[src]
pub fn new_ym(year: i32, month: i32) -> DateTime
Creates a new DateTime
using the date and times in the gregorian calendar
in the local timezone.
year
should be from 1 to 9999, month
should be from 1 to 12.
If value is -1 then all over value will be ignored. For example
if month
== -1, then DateTime
will created only for year
.
Free-function: gst_date_time_unref
year
the gregorian year
month
the gregorian month
Returns
the newly created DateTime
pub fn new_ymd(year: i32, month: i32, day: i32) -> DateTime
[src]
pub fn new_ymd(year: i32, month: i32, day: i32) -> DateTime
Creates a new DateTime
using the date and times in the gregorian calendar
in the local timezone.
year
should be from 1 to 9999, month
should be from 1 to 12, day
from
1 to 31.
If value is -1 then all over value will be ignored. For example
if month
== -1, then DateTime
will created only for year
. If
day
== -1, then DateTime
will created for year
and month
and
so on.
Free-function: gst_date_time_unref
year
the gregorian year
month
the gregorian month
day
the day of the gregorian month
Returns
the newly created DateTime
pub fn get_day(&self) -> i32
[src]
pub fn get_day(&self) -> i32
Returns the day of the month of this DateTime
.
Call gst_date_time_has_day before, to avoid warnings.
Returns
The day of this DateTime
pub fn get_hour(&self) -> i32
[src]
pub fn get_hour(&self) -> i32
Retrieves the hour of the day represented by self
in the gregorian
calendar. The return is in the range of 0 to 23.
Call gst_date_time_has_haur before, to avoid warnings.
Returns
the hour of the day
pub fn get_microsecond(&self) -> i32
[src]
pub fn get_microsecond(&self) -> i32
Retrieves the fractional part of the seconds in microseconds represented by
self
in the gregorian calendar.
Returns
the microsecond of the second
pub fn get_minute(&self) -> i32
[src]
pub fn get_minute(&self) -> i32
Retrieves the minute of the hour represented by self
in the gregorian
calendar.
Call gst_date_time_has_minute before, to avoid warnings.
Returns
the minute of the hour
pub fn get_month(&self) -> i32
[src]
pub fn get_month(&self) -> i32
Returns the month of this DateTime
. January is 1, February is 2, etc..
Call gst_date_time_has_month before, to avoid warnings.
Returns
The month of this DateTime
pub fn get_second(&self) -> i32
[src]
pub fn get_second(&self) -> i32
Retrieves the second of the minute represented by self
in the gregorian
calendar.
Call gst_date_time_has_second before, to avoid warnings.
Returns
the second represented by self
pub fn get_time_zone_offset(&self) -> f32
[src]
pub fn get_time_zone_offset(&self) -> 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.
Returns
the offset from UTC in hours
pub fn get_year(&self) -> i32
[src]
pub fn get_year(&self) -> i32
Returns the year of this DateTime
Call gst_date_time_has_year before, to avoid warnings.
Returns
The year of this DateTime
pub fn has_day(&self) -> bool
[src]
pub fn has_day(&self) -> bool
Returns
true
if self
's day field is set, otherwise false
pub fn has_month(&self) -> bool
[src]
pub fn has_month(&self) -> bool
Returns
true
if self
's month field is set, otherwise false
pub fn has_second(&self) -> bool
[src]
pub fn has_second(&self) -> bool
Returns
true
if self
's second field is set, otherwise false
pub fn has_time(&self) -> bool
[src]
pub fn has_time(&self) -> bool
Returns
true
if self
's hour and minute fields are set,
otherwise false
pub fn has_year(&self) -> bool
[src]
pub fn has_year(&self) -> bool
Returns
true
if self
's year field is set (which should always
be the case), otherwise false
pub fn to_g_date_time(&self) -> Option<DateTime>
[src]
pub fn to_g_date_time(&self) -> Option<DateTime>
Creates a new glib::DateTime
from a fully defined DateTime
object.
Free-function: g_date_time_unref
Returns
a newly created glib::DateTime
, or
None
on error
pub fn to_iso8601_string(&self) -> Option<String>
[src]
pub fn to_iso8601_string(&self) -> Option<String>
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. The string should
be freed with g_free
.
Trait Implementations
impl Debug for DateTime
[src]
impl Debug for DateTime
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for DateTime
[src]
impl PartialEq for DateTime
fn eq(&self, other: &DateTime) -> bool
[src]
fn eq(&self, other: &DateTime) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &DateTime) -> bool
[src]
fn ne(&self, other: &DateTime) -> bool
This method tests for !=
.
impl Eq for DateTime
[src]
impl Eq for DateTime
impl PartialOrd for DateTime
[src]
impl PartialOrd for DateTime
fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &DateTime) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &DateTime) -> bool
[src]
fn lt(&self, other: &DateTime) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &DateTime) -> bool
[src]
fn le(&self, other: &DateTime) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &DateTime) -> bool
[src]
fn gt(&self, other: &DateTime) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &DateTime) -> bool
[src]
fn ge(&self, other: &DateTime) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for DateTime
[src]
impl Ord for DateTime
fn cmp(&self, other: &DateTime) -> Ordering
[src]
fn cmp(&self, other: &DateTime) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
impl Hash for DateTime
[src]
impl Hash for DateTime
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Clone for DateTime
impl Clone for DateTime
fn clone(&self) -> DateTime
fn clone(&self) -> DateTime
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl StaticType for DateTime
impl StaticType for DateTime
fn static_type() -> Type
fn static_type() -> Type
Returns the type identifier of Self
.
impl Send for DateTime
[src]
impl Send for DateTime
impl Sync for DateTime
[src]
impl Sync for DateTime
impl Display for DateTime
[src]
impl Display for DateTime
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'a> Serialize for DateTime
[src]
impl<'a> Serialize for DateTime
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>
[src]
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>
Serialize this value into the given Serde serializer. Read more
impl<'de> Deserialize<'de> for DateTime
[src]
impl<'de> Deserialize<'de> for DateTime
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
[src]
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>
Deserialize this value from the given Serde deserializer. Read more