Meziantou.Framework

TomlDateTime Struct

Namespace
Meziantou.Framework.Toml
Assembly
Meziantou.Framework.Toml.dll
Package
Meziantou.Framework.Toml 1.0.4
Source
TomlDateTime.cs
Available in package assets
net10.0net11.0

A datetime value that can represent a TOML - An offset DateTime with Zero offset or Number offset. - A local DateTime. - A local Date. - A local Time.

public struct TomlDateTime : IConvertible, IEquatable<TomlDateTime>
Implements

Constructors

NameDescription
TomlDateTime(DateTime)Initializes a local-date-time TOML value from a TomlDateTime.DateTime.
TomlDateTime(DateTimeOffset, int, TomlDateTimeKind)A datetime value that can represent a TOML - An offset DateTime with Zero offset or Number offset. - A local DateTime. - A local Date. - A local Time.
TomlDateTime(int, int, int)Initializes a local-date TOML value from a date component.

TomlDateTime overloads

TomlDateTime(DateTime)

TomlDateTime.cs

Initializes a local-date-time TOML value from a TomlDateTime.DateTime.

public TomlDateTime(DateTime datetime)
Parameters
datetime DateTime
The date/time value. Its wall-clock value is used, whatever its DateTime.Kind, and its fractional seconds are kept.

TomlDateTime(DateTimeOffset, int, TomlDateTimeKind)

A datetime value that can represent a TOML - An offset DateTime with Zero offset or Number offset. - A local DateTime. - A local Date. - A local Time.

public TomlDateTime(DateTimeOffset DateTime, int SecondPrecision, TomlDateTimeKind Kind)
Parameters
DateTime DateTimeOffset
The datetime offset.
SecondPrecision int
The precision of milliseconds.
Kind TomlDateTimeKind
The kind of datetime offset.

TomlDateTime(int, int, int)

TomlDateTime.cs

Initializes a local-date TOML value from a date component.

public TomlDateTime(int year, int month, int day)
Parameters
year int
The year component.
month int
The month component.
day int
The day component.

Properties

NameDescription
DateTimeThe datetime offset.
KindThe kind of datetime offset.
SecondPrecisionThe precision of milliseconds.

DateTime

TomlDateTime.cs

The datetime offset.

public DateTimeOffset DateTime { readonly get; set; }

Property value

DateTimeOffset

Kind

TomlDateTime.cs

The kind of datetime offset.

public TomlDateTimeKind Kind { readonly get; set; }

Property value

TomlDateTimeKind

SecondPrecision

TomlDateTime.cs

The precision of milliseconds.

public int SecondPrecision { readonly get; set; }

Property value

int

Methods

NameDescription
Deconstruct(DateTimeOffset, int, TomlDateTimeKind)
Equals(TomlDateTime)Indicates whether two values are the same TOML value: the same TomlDateTime.Kind and the same instant for offset date-times, or the same date, time, or both for local values.
Equals(object)
GetFormatPrecision(int)Gets the string formatter for the specified precision.
GetHashCode()Returns the hash code for this instance.
System.IConvertible.GetTypeCode()
System.IConvertible.ToBoolean(IFormatProvider?)
System.IConvertible.ToByte(IFormatProvider?)
System.IConvertible.ToChar(IFormatProvider?)
System.IConvertible.ToDateTime(IFormatProvider?)
System.IConvertible.ToDecimal(IFormatProvider?)
System.IConvertible.ToDouble(IFormatProvider?)
System.IConvertible.ToInt16(IFormatProvider?)
System.IConvertible.ToInt32(IFormatProvider?)
System.IConvertible.ToInt64(IFormatProvider?)
System.IConvertible.ToSByte(IFormatProvider?)
System.IConvertible.ToSingle(IFormatProvider?)
System.IConvertible.ToString(IFormatProvider?)
System.IConvertible.ToType(Type, IFormatProvider?)
System.IConvertible.ToUInt16(IFormatProvider?)
System.IConvertible.ToUInt32(IFormatProvider?)
System.IConvertible.ToUInt64(IFormatProvider?)
ToString()Returns the fully qualified type name of this instance.

Deconstruct(DateTimeOffset, int, TomlDateTimeKind)

public readonly void Deconstruct(out DateTimeOffset DateTime, out int SecondPrecision, out TomlDateTimeKind Kind)

Parameters

DateTime DateTimeOffset
SecondPrecision int
Kind TomlDateTimeKind

No documentation is available.

Equals overloads

Equals(TomlDateTime)

TomlDateTime.cs

Indicates whether two values are the same TOML value: the same TomlDateTime.Kind and the same instant for offset date-times, or the same date, time, or both for local values.

public readonly bool Equals(TomlDateTime other)
Parameters
other TomlDateTime
Returns

bool

Remarks

TomlDateTime.SecondPrecision only affects how the value is written, so 07:32:00.5 equals 07:32:00.50. A local value has no offset: the offset of TomlDateTime.DateTime is ignored, and so is the time of a local date and the date of a local time.

Equals(object)

public override readonly bool Equals(object obj)
Parameters
obj object
Returns

bool

No documentation is available.

GetFormatPrecision(int)

TomlDateTime.cs

Gets the string formatter for the specified precision.

public static string GetFormatPrecision(int precision)

Parameters

precision int
A precision number from 1 to 7. Other numbers will return the default `fff` formatter.

Returns

string The string formatter for the specified precision.

GetHashCode()

TomlDateTime.cs

Returns the hash code for this instance.

public override readonly int GetHashCode()

Returns

int A 32-bit signed integer that is the hash code for this instance.

System.IConvertible.GetTypeCode()

TomlDateTime.cs
TypeCode IConvertible.GetTypeCode()

Returns

TypeCode

No documentation is available.

System.IConvertible.ToBoolean(IFormatProvider?)

TomlDateTime.cs
bool IConvertible.ToBoolean(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

bool

No documentation is available.

System.IConvertible.ToByte(IFormatProvider?)

TomlDateTime.cs
byte IConvertible.ToByte(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

byte

No documentation is available.

System.IConvertible.ToChar(IFormatProvider?)

TomlDateTime.cs
char IConvertible.ToChar(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

char

No documentation is available.

System.IConvertible.ToDateTime(IFormatProvider?)

TomlDateTime.cs
DateTime IConvertible.ToDateTime(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

DateTime

No documentation is available.

System.IConvertible.ToDecimal(IFormatProvider?)

TomlDateTime.cs
decimal IConvertible.ToDecimal(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

decimal

No documentation is available.

System.IConvertible.ToDouble(IFormatProvider?)

TomlDateTime.cs
double IConvertible.ToDouble(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

double

No documentation is available.

System.IConvertible.ToInt16(IFormatProvider?)

TomlDateTime.cs
short IConvertible.ToInt16(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

short

No documentation is available.

System.IConvertible.ToInt32(IFormatProvider?)

TomlDateTime.cs
int IConvertible.ToInt32(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

int

No documentation is available.

System.IConvertible.ToInt64(IFormatProvider?)

TomlDateTime.cs
long IConvertible.ToInt64(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

long

No documentation is available.

System.IConvertible.ToSByte(IFormatProvider?)

TomlDateTime.cs
sbyte IConvertible.ToSByte(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

sbyte

No documentation is available.

System.IConvertible.ToSingle(IFormatProvider?)

TomlDateTime.cs
float IConvertible.ToSingle(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

float

No documentation is available.

System.IConvertible.ToString(IFormatProvider?)

TomlDateTime.cs
string IConvertible.ToString(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

string

No documentation is available.

System.IConvertible.ToType(Type, IFormatProvider?)

TomlDateTime.cs
object IConvertible.ToType(Type conversionType, IFormatProvider? provider)

Parameters

conversionType Type
provider IFormatProvider?

Returns

object

No documentation is available.

System.IConvertible.ToUInt16(IFormatProvider?)

TomlDateTime.cs
ushort IConvertible.ToUInt16(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

ushort

No documentation is available.

System.IConvertible.ToUInt32(IFormatProvider?)

TomlDateTime.cs
uint IConvertible.ToUInt32(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

uint

No documentation is available.

System.IConvertible.ToUInt64(IFormatProvider?)

TomlDateTime.cs
ulong IConvertible.ToUInt64(IFormatProvider? provider)

Parameters

provider IFormatProvider?

Returns

ulong

No documentation is available.

ToString()

TomlDateTime.cs

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string The fully qualified type name.

Operators

NameDescription
operator ==(TomlDateTime, TomlDateTime)
implicit operator TomlDateTime(DateTime)Converts a datetime to TomlDateTime, the way the serializer writes it.
operator !=(TomlDateTime, TomlDateTime)

operator ==(TomlDateTime, TomlDateTime)

public static bool operator ==(TomlDateTime left, TomlDateTime right)

Parameters

left TomlDateTime
right TomlDateTime

Returns

bool

No documentation is available.

implicit operator TomlDateTime(DateTime)

TomlDateTime.cs

Converts a datetime to TomlDateTime, the way the serializer writes it.

public static implicit operator TomlDateTime(DateTime dateTime)

Parameters

dateTime DateTime

Returns

TomlDateTime

Exceptions

TomlException
A local value near DateTime.MinValue or DateTime.MaxValue is out of range once converted to UTC.

Remarks

A DateTimeKind.Utc value is an offset date-time with Z, a DateTimeKind.Local value an offset date-time with the offset of the machine, and an DateTimeKind.Unspecified value a local date-time. The fractional seconds are kept.

operator !=(TomlDateTime, TomlDateTime)

public static bool operator !=(TomlDateTime left, TomlDateTime right)

Parameters

left TomlDateTime
right TomlDateTime

Returns

bool

No documentation is available.