GI.Soup.Structs.Date

A date and time. The date is assumed to be in the (proleptic) Gregorian calendar. The time is in UTC if utc is True. Otherwise, the time is a local time, and offset gives the offset from UTC in minutes (such that adding offset to the time would give the correct UTC time). If utc is False and offset is 0, then the SoupDate represents a "floating" time with no associated timezone information.

Exported types

newtype Date

Constructors

Date (ManagedPtr Date)

Instances

BoxedObject Date

Methods

boxedType :: Date -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Date tag

Methods

new :: MonadIO m => (ManagedPtr Date -> Date) -> [AttrOp Date tag] -> m Date

((~) * info (ResolveDateMethod t Date), MethodInfo * info Date p) => IsLabel t (Date -> p)

Methods

fromLabel :: Proxy# Symbol t -> Date -> p

((~) * info (ResolveDateMethod t Date), MethodInfo * info Date p) => IsLabelProxy t (Date -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Date -> p

HasAttributeList * Date

((~) * signature (m TimeVal), MonadIO m) => MethodInfo * DateToTimevalMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToTimevalMethodInfo Date -> signature -> s

((~) * signature (m CLong), MonadIO m) => MethodInfo * DateToTimeTMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToTimeTMethodInfo Date -> signature -> s

((~) * signature (DateFormat -> m Text), MonadIO m) => MethodInfo * DateToStringMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToStringMethodInfo Date -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * DateIsPastMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateIsPastMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetYearMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetYearMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetUtcMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetUtcMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetSecondMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetSecondMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetOffsetMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetOffsetMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetMonthMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetMonthMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetMinuteMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetMinuteMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetHourMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetHourMethodInfo Date -> signature -> s

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetDayMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetDayMethodInfo Date -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * DateFreeMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateFreeMethodInfo Date -> signature -> s

((~) * signature (m Date), MonadIO m) => MethodInfo * DateCopyMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateCopyMethodInfo Date -> signature -> s

type AttributeList Date

type AttributeList Date

newZeroDate :: MonadIO m => m Date

Construct a Date struct initialized to zero.

noDate :: Maybe Date

Methods

copy

data DateCopyMethodInfo

Instances

((~) * signature (m Date), MonadIO m) => MethodInfo * DateCopyMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateCopyMethodInfo Date -> signature -> s

dateCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Date

Copies date.

Since: 2.24

free

data DateFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * DateFreeMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateFreeMethodInfo Date -> signature -> s

dateFree

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m ()

Frees date.

Since: 2.24

getDay

data DateGetDayMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetDayMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetDayMethodInfo Date -> signature -> s

dateGetDay

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's day

Gets date's day.

Since: 2.32

getHour

data DateGetHourMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetHourMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetHourMethodInfo Date -> signature -> s

dateGetHour

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's hour

Gets date's hour.

Since: 2.32

getMinute

data DateGetMinuteMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetMinuteMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetMinuteMethodInfo Date -> signature -> s

dateGetMinute

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's minute

Gets date's minute.

Since: 2.32

getMonth

data DateGetMonthMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetMonthMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetMonthMethodInfo Date -> signature -> s

dateGetMonth

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's month

Gets date's month.

Since: 2.32

getOffset

data DateGetOffsetMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetOffsetMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetOffsetMethodInfo Date -> signature -> s

dateGetOffset

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's offset from UTC. If dateGetUtc returns False but dateGetOffset returns 0, that means the date is a "floating" time with no associated offset information.

Gets date's offset from UTC.

Since: 2.32

getSecond

data DateGetSecondMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetSecondMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetSecondMethodInfo Date -> signature -> s

dateGetSecond

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's second

Gets date's second.

Since: 2.32

getUtc

data DateGetUtcMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetUtcMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetUtcMethodInfo Date -> signature -> s

dateGetUtc

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: True if date is UTC.

Gets date's UTC flag

Since: 2.32

getYear

data DateGetYearMethodInfo

Instances

((~) * signature (m Int32), MonadIO m) => MethodInfo * DateGetYearMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateGetYearMethodInfo Date -> signature -> s

dateGetYear

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Int32

Returns: date's year

Gets date's year.

Since: 2.32

isPast

data DateIsPastMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * DateIsPastMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateIsPastMethodInfo Date -> signature -> s

dateIsPast

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m Bool

Returns: True if date is in the past

Determines if date is in the past.

Since: 2.24

new

dateNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

year: the year (1-9999)

-> Int32

month: the month (1-12)

-> Int32

day: the day of the month (1-31, as appropriate for month)

-> Int32

hour: the hour (0-23)

-> Int32

minute: the minute (0-59)

-> Int32

second: the second (0-59, or up to 61 for leap seconds)

-> m Date

Returns: a new Date

Creates a Date representing the indicated time, UTC.

newFromNow

dateNewFromNow

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

offsetSeconds: offset from current time

-> m Date

Returns: a new Date

Creates a Date representing a time offsetSeconds after the current time (or before it, if offsetSeconds is negative). If offset_seconds is 0, returns the current time.

If offsetSeconds would indicate a time not expressible as a <type>time_t</type>, the return value will be clamped into range.

newFromString

dateNewFromString

Arguments

:: (HasCallStack, MonadIO m)

=> Text

dateString: the date in some plausible format

-> m (Maybe Date)

Returns: a new Date, or Nothing if dateString could not be parsed.

Parses dateString and tries to extract a date from it. This recognizes all of the "HTTP-date" formats from RFC 2616, all ISO 8601 formats containing both a time and a date, RFC 2822 dates, and reasonable approximations thereof. (Eg, it is lenient about whitespace, leading "0"s, etc.)

newFromTimeT

dateNewFromTimeT

Arguments

:: (HasCallStack, MonadIO m)

=> CLong

when: a <type>time_t</type>

-> m Date

Returns: a new Date

Creates a Date corresponding to when

toString

data DateToStringMethodInfo

Instances

((~) * signature (DateFormat -> m Text), MonadIO m) => MethodInfo * DateToStringMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToStringMethodInfo Date -> signature -> s

dateToString

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> DateFormat

format: the format to generate the date in

-> m Text

Returns: date as a string

Converts date to a string in the format described by format.

toTimeT

data DateToTimeTMethodInfo

Instances

((~) * signature (m CLong), MonadIO m) => MethodInfo * DateToTimeTMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToTimeTMethodInfo Date -> signature -> s

dateToTimeT

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m CLong

Returns: date as a <type>time_t</type>

Converts date to a <type>time_t</type>.

If date is not representable as a <type>time_t</type>, it will be clamped into range. (In particular, some HTTP cookies have expiration dates after "Y2.038k" (2038-01-19T03:14:07Z).)

toTimeval

data DateToTimevalMethodInfo

Instances

((~) * signature (m TimeVal), MonadIO m) => MethodInfo * DateToTimevalMethodInfo Date signature

Methods

overloadedMethod :: MethodProxy DateToTimevalMethodInfo Date -> signature -> s

dateToTimeval

Arguments

:: (HasCallStack, MonadIO m)

=> Date

date: a Date

-> m TimeVal

Converts date to a TimeVal.

Since: 2.24

Properties

day

date_day :: AttrLabelProxy "day"

getDateDay :: MonadIO m => Date -> m Int32

setDateDay :: MonadIO m => Date -> Int32 -> m ()

hour

date_hour :: AttrLabelProxy "hour"

getDateHour :: MonadIO m => Date -> m Int32

setDateHour :: MonadIO m => Date -> Int32 -> m ()

minute

date_minute :: AttrLabelProxy "minute"

getDateMinute :: MonadIO m => Date -> m Int32

setDateMinute :: MonadIO m => Date -> Int32 -> m ()

month

date_month :: AttrLabelProxy "month"

getDateMonth :: MonadIO m => Date -> m Int32

setDateMonth :: MonadIO m => Date -> Int32 -> m ()

offset

date_offset :: AttrLabelProxy "offset"

getDateOffset :: MonadIO m => Date -> m Int32

setDateOffset :: MonadIO m => Date -> Int32 -> m ()

second

date_second :: AttrLabelProxy "second"

getDateSecond :: MonadIO m => Date -> m Int32

setDateSecond :: MonadIO m => Date -> Int32 -> m ()

utc

date_utc :: AttrLabelProxy "utc"

getDateUtc :: MonadIO m => Date -> m Bool

setDateUtc :: MonadIO m => Date -> Bool -> m ()

year

date_year :: AttrLabelProxy "year"

getDateYear :: MonadIO m => Date -> m Int32

setDateYear :: MonadIO m => Date -> Int32 -> m ()