DtObj Rust Reference Documentation

DtObj

Current Version: 11.6.1

Chilkat.DtObj

Represent a date/time as simple editable fields.

Chilkat.DtObj is a lightweight date/time value object used by Chilkat methods that need to pass or return individual date and time fields. It stores values such as year, month, day, hour, minute, and second, along with a flag indicating whether the value represents UTC or local time. It also provides a compact serialization format for saving and restoring the date/time value.

Simple date fields

Store and edit the year, month, day, hour, minute, and second as individual properties.

UTC or local time

Use the UTC flag to indicate whether the stored fields represent UTC or local time.

Struct tm compatibility

Use alternate month and year properties when working with struct tm-style date/time conventions.

Serialize and restore

Save and restore the object using Chilkat's compact internal serialized date/time representation.

Used by other classes

Pass DtObj values to Chilkat methods that require explicit date/time fields or return date/time information.

Small and focused

Use this class as a simple container rather than a full date/time calculation or timezone-conversion engine.

Common pattern: Create or receive a DtObj, set or read the individual date/time fields, check whether the value is UTC or local time, and pass the object to another Chilkat method. Use serialization only when the date/time value needs to be saved and restored in Chilkat's compact internal format.

For an extended overview, see DtObj Class Overview.

Object Creation

// Cargo.toml:
//     [dependencies]
//     chilkat = "11.6"

use chilkat::DtObj;

// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?;  // shorthand for Global::new().unlock_bundle(..)

let dt_obj = DtObj::new();
// ... the native object is freed when `dt_obj` goes out of scope.

pub fn new() -> DtObj

Creates the underlying native Chilkat object (DtObj also implements Default). Every method takes &self, so the object never needs to be declared mut. A DtObj is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.

impl Drop for DtObj

The native object is freed when the DtObj is dropped — when it goes out of scope, or explicitly with drop(dt_obj). There is no Dispose method to call.

Errors

Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<DtObj>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.

match dt_obj.some_method(...) {
    Ok(value) => println!("{value:?}"),
    Err(e) => eprintln!("{}", e.last_error_text()),
}

Properties

Day

// read/write
pub fn day(&self) -> i32
pub fn set_day(&self, value: i32)

The day of the month. The valid values for this member are 1 through 31.

DtObj Rust Reference Documentation

DtObj

Current Version: 11.6.1

Represent a date/time as simple editable fields.

Simple date fields

UTC or local time

Struct tm compatibility

Serialize and restore

Used by other classes

Small and focused

Object Creation

Errors

Properties

Day

DebugLogFilePath

Hour

LastErrorHtml

LastErrorText

LastErrorXml

LastMethodSuccess

Minute

Month

Second

StructTmMonth

StructTmYear

Utc

VerboseLogging

Version

Year

Methods

DeSerialize

Serialize