Struct boa_engine::object::builtins::JsDate

pub struct JsDate { /* private fields */ }

JsDate is a wrapper for JavaScript JsDate builtin object

Example

Create a JsDate object and set date to December 4 1995

use boa_engine::{
    js_string, object::builtins::JsDate, Context, JsResult, JsValue,
};

fn main() -> JsResult<()> {
    // JS mutable Context
    let context = &mut Context::default();

    let date = JsDate::new(context);

    date.set_full_year(&[1995.into(), 11.into(), 4.into()], context)?;

    assert_eq!(
        date.to_date_string(context)?,
        JsValue::from(js_string!("Mon Dec 04 1995"))
    );

    Ok(())
}

Implementations

impl JsDate

pub fn new(context: &mut Context) -> Self

Create a new Date object with universal time.

pub fn from_object(object: JsObject) -> JsResult<Self>

Create a new JsDate object from an existing object.

pub fn now(context: &mut Context) -> JsResult<JsValue>

Return a Number representing the milliseconds elapsed since the UNIX epoch.

Same as JavaScript’s Date.now()

pub fn parse(value: JsValue, context: &mut Context) -> JsResult<JsValue>

Parse a String representation of date. String should be ISO 8601 format. Returns the Number of milliseconds since UNIX epoch if String is valid, else return a NaN.

Same as JavaScript’s Date.parse(value).

pub fn utc(values: &[JsValue], context: &mut Context) -> JsResult<JsValue>

Takes a [year, month, day, hour, minute, second, millisecond] Return a Number representing the milliseconds elapsed since the UNIX epoch.

Same as JavaScript’s Date.UTC()

pub fn get_date(&self, context: &mut Context) -> JsResult<JsValue>

Returns the day of the month(1-31) for the specified date according to local time.

Same as JavaScript’s Date.prototype.getDate().

pub fn get_day(&self, context: &mut Context) -> JsResult<JsValue>

Returns the day of the week (0–6) for the specified date according to local time.

Same as JavaScript’s Date.prototype.getDay().

pub fn get_full_year(&self, context: &mut Context) -> JsResult<JsValue>

Returns the year (4 digits for 4-digit years) of the specified date according to local time.

Same as JavaScript’s Date.prototype.getFullYear().

pub fn get_hours(&self, context: &mut Context) -> JsResult<JsValue>

Returns the hour (0–23) in the specified date according to local time.

Same as JavaScript’s Date.prototype.getHours().

pub fn get_milliseconds(&self, context: &mut Context) -> JsResult<JsValue>

Returns the milliseconds (0–999) in the specified date according to local time.

Same as JavaScript’s Date.prototype.getMilliseconds().

pub fn get_minutes(&self, context: &mut Context) -> JsResult<JsValue>

Returns the minutes (0–59) in the specified date according to local time.

Same as JavaScript’s Date.prototype.getMinutes().

pub fn get_month(&self, context: &mut Context) -> JsResult<JsValue>

Returns the month (0–11) in the specified date according to local time.

Same as JavaScript’s Date.prototype.getMonth().

pub fn get_seconds(&self, context: &mut Context) -> JsResult<JsValue>

Returns the seconds (0–59) in the specified date according to local time.

Same as JavaScript’s Date.prototype.getSeconds().

pub fn get_time(&self, context: &mut Context) -> JsResult<JsValue>

Returns the numeric value of the specified date as the number of milliseconds since UNIX epoch. Negative values are returned for prior times.

Same as JavaScript’s Date.prototype.getTime().

pub fn get_timezone_offset(&self, context: &mut Context) -> JsResult<JsValue>

Returns the time-zone offset in minutes for the current locale.

Same as JavaScript’s Date.prototype.getTimezoneOffset().

pub fn get_utc_date(&self, context: &mut Context) -> JsResult<JsValue>

Returns the day (date) of the month (1–31) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCDate().

pub fn get_utc_day(&self, context: &mut Context) -> JsResult<JsValue>

Returns the day of the week (0–6) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCDay().

pub fn get_utc_full_year(&self, context: &mut Context) -> JsResult<JsValue>

Returns the year (4 digits for 4-digit years) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCFullYear().

pub fn get_utc_hours(&self, context: &mut Context) -> JsResult<JsValue>

Returns the hours (0–23) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCHours().

pub fn get_utc_milliseconds(&self, context: &mut Context) -> JsResult<JsValue>

Returns the milliseconds (0–999) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCMilliseconds().

pub fn get_utc_minutes(&self, context: &mut Context) -> JsResult<JsValue>

Returns the minutes (0–59) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCMinutes().

pub fn get_utc_month(&self, context: &mut Context) -> JsResult<JsValue>

Returns the month (0–11) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCMonth().

pub fn get_utc_seconds(&self, context: &mut Context) -> JsResult<JsValue>

Returns the seconds (0–59) in the specified date according to universal time.

Same as JavaScript’s Date.prototype.getUTCSeconds().

pub fn set_date<T>(&self, value: T, context: &mut Context) -> JsResult<JsValue>

where T: Into<JsValue>,

Sets the day of the month for a specified date according to local time. Takes a month_value. Return a Number representing the milliseconds elapsed between the UNIX epoch and the given date.

Same as JavaScript’s Date.prototype.setDate().

pub fn set_full_year( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the full year (e.g. 4 digits for 4-digit years) for a specified date according to local time. Takes [year_value, month_value, date_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and updated date.

Same as JavaScript’s Date.prototype.setFullYear().

pub fn set_hours( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the hours for a specified date according to local time. Takes [hours_value, minutes_value, seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setHours().

pub fn set_milliseconds<T>( &self, value: T, context: &mut Context ) -> JsResult<JsValue>

where T: Into<JsValue>,

Sets the milliseconds for a specified date according to local time. Takes a milliseconds_value Return a Number representing the milliseconds elapsed between the UNIX epoch and updated date.

Same as JavaScript’s Date.prototype.setMilliseconds().

pub fn set_minutes( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the minutes for a specified date according to local time. Takes [minutes_value, seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setMinutes().

pub fn set_month( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the month for a specified date according to local time. Takes [month_value, day_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setMonth().

pub fn set_seconds( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the seconds for a specified date according to local time. Takes [seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setSeconds().

pub fn set_time<T>(&self, value: T, context: &mut Context) -> JsResult<JsValue>

where T: Into<JsValue>,

Sets the Date object to the time represented by a number of milliseconds since UNIX epoch. Takes number of milliseconds since UNIX epoch. Use negative numbers for times prior. Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setTime().

pub fn set_utc_date<T>( &self, value: T, context: &mut Context ) -> JsResult<JsValue>

where T: Into<JsValue>,

Sets the day of the month for a specified date according to universal time. Takes a month_value. Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCDate().

pub fn set_utc_full_year( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the full year (e.g. 4 digits for 4-digit years) for a specified date according to universal time. Takes [year_value, month_value, date_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCFullYear().

pub fn set_utc_hours( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the hours for a specified date according to universal time. Takes [hours_value, minutes_value, seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated dated.

Same as JavaScript’s Date.prototype.setUTCHours().

pub fn set_utc_milliseconds<T>( &self, value: T, context: &mut Context ) -> JsResult<JsValue>

where T: Into<JsValue>,

Sets the milliseconds for a specified date according to universal time. Takes a milliseconds_value Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCMilliseconds().

pub fn set_utc_minutes( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the minutes for a specified date according to universal time. Takes [minutes_value, seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCMinutes().

pub fn set_utc_month( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the month for a specified date according to universal time. Takes [month_value, day_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCMonth().

pub fn set_utc_seconds( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Sets the seconds for a specified date according to universal time. Takes [seconds_value, ms_value] Return a Number representing the milliseconds elapsed between the UNIX epoch and the updated date.

Same as JavaScript’s Date.prototype.setUTCSeconds().

pub fn to_date_string(&self, context: &mut Context) -> JsResult<JsValue>

Returns the “date” portion of the Date as a human-readable string.

Same as JavaScript’s Date.prototype.toDateString().

pub fn to_gmt_string(&self, context: &mut Context) -> JsResult<JsValue>

👎Deprecated

DEPRECATED: This feature is no longer recommended. USE: to_utc_string() instead. Returns a string representing the Date based on the GMT timezone.

Same as JavaScript’s legacy Date.prototype.toGMTString()

pub fn to_iso_string(&self, context: &mut Context) -> JsResult<JsValue>

Returns the given date in the ISO 8601 format according to universal time.

Same as JavaScript’s Date.prototype.toISOString().

pub fn to_json(&self, context: &mut Context) -> JsResult<JsValue>

Returns a string representing the Date using to_iso_string().

Same as JavaScript’s Date.prototype.toJSON().

pub fn to_local_date_string( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Returns a string representing the date portion of the given Date instance according to language-specific conventions. Takes [locales, options]

Same as JavaScript’s Date.prototype.toLocaleDateString().

pub fn to_locale_string( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Returns a string representing the given date according to language-specific conventions. Takes [locales, options]

Same as JavaScript’s Date.prototype.toLocaleDateString().

pub fn to_locale_time_string( &self, values: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Returns the “time” portion of the Date as human-readable string.

Same as JavaScript’s Date.prototype.toTimeString().

pub fn to_string(&self, context: &mut Context) -> JsResult<JsValue>

Returns a string representing the specified Date object.

Same as JavaScript’s Date.prototype.toString().

pub fn to_time_string(&self, context: &mut Context) -> JsResult<JsValue>

Returns the “time” portion of the Date as human-readable string.

Same as JavaScript’s Date.prototype.toTimeString().

pub fn to_utc_string(&self, context: &mut Context) -> JsResult<JsValue>

Returns a string representing the given date using the UTC time zone.

Same as JavaScript’s Date.prototype.toUTCString().

pub fn value_of(&self, context: &mut Context) -> JsResult<JsValue>

Returns the primitive value pf Date object.

Same as JavaScript’s Date.prototype.valueOf().

pub fn new_from_parse(value: &JsValue, context: &mut Context) -> JsResult<Self>

Utility create a Date object from RFC3339 string

Methods from Deref<Target = JsObject>

pub fn downcast_ref<T: NativeObject>(&self) -> Option<Ref<'_, T>>

Downcasts a reference to the object, if the object is of type T.

Panics

Panics if the object is currently mutably borrowed.

pub fn downcast_mut<T: NativeObject>( &self ) -> Option<RefMut<'_, ErasedObject, T>>

Downcasts a mutable reference to the object, if the object is type native object type T.

Panics

Panics if the object is currently borrowed.

pub fn is<T: NativeObject>(&self) -> bool

Checks if this object is an instance of a certain NativeObject.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_ordinary(&self) -> bool

Checks if it’s an ordinary object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_array(&self) -> bool

Checks if it’s an Array object.

pub fn to_property_descriptor( &self, context: &mut Context ) -> JsResult<PropertyDescriptor>

The abstract operation ToPropertyDescriptor.

More information:

• ECMAScript reference

pub fn copy_data_properties<K>( &self, source: &JsValue, excluded_keys: Vec<K>, context: &mut Context ) -> JsResult<()>

where K: Into<PropertyKey>,

7.3.25 CopyDataProperties ( target, source, excludedItems )

More information:

• ECMAScript

pub fn borrow(&self) -> Ref<'_, Object<T>>

Immutably borrows the Object.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

Panics

Panics if the object is currently mutably borrowed.

pub fn borrow_mut(&self) -> RefMut<'_, Object<T>, Object<T>>

Mutably borrows the Object.

The borrow lasts until the returned RefMut exits scope. The object cannot be borrowed while this borrow is active.

Panics

Panics if the object is currently borrowed.

pub fn try_borrow(&self) -> StdResult<Ref<'_, Object<T>>, BorrowError>

Immutably borrows the Object, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned GcCellRef exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of borrow.

pub fn try_borrow_mut( &self ) -> StdResult<RefMut<'_, Object<T>, Object<T>>, BorrowMutError>

Mutably borrows the object, returning an error if the value is currently borrowed.

The borrow lasts until the returned GcCellRefMut exits scope. The object be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn prototype(&self) -> JsPrototype

Get the prototype of the object.

Panics

Panics if the object is currently mutably borrowed.

pub fn set_prototype(&self, prototype: JsPrototype) -> bool

Set the prototype of the object.

Panics

Panics if the object is currently mutably borrowed

pub fn insert_property<K, P>(&self, key: K, property: P) -> bool

where K: Into<PropertyKey>, P: Into<PropertyDescriptor>,

Inserts a field in the object properties without checking if it’s writable.

If a field was already in the object with the same name, than true is returned with that field, otherwise false is returned.

pub fn is_callable(&self) -> bool

It determines if Object is a callable function with a [[Call]] internal method.

More information:

• ECMAScript reference

pub fn is_constructor(&self) -> bool

It determines if Object is a function object with a [[Construct]] internal method.

More information:

• ECMAScript reference

pub fn is_extensible(&self, context: &mut Context) -> JsResult<bool>

Check if object is extensible.

More information:

• ECMAScript reference

pub fn get<K>(&self, key: K, context: &mut Context) -> JsResult<JsValue>

where K: Into<PropertyKey>,

Get property from object or throw.

More information:

• ECMAScript reference

pub fn set<K, V>( &self, key: K, value: V, throw: bool, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>, V: Into<JsValue>,

set property of object or throw if bool flag is passed.

More information:

• ECMAScript reference

pub fn create_data_property<K, V>( &self, key: K, value: V, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>, V: Into<JsValue>,

Create data property

More information:

• ECMAScript reference

pub fn create_data_property_or_throw<K, V>( &self, key: K, value: V, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>, V: Into<JsValue>,

Create data property or throw

More information:

• ECMAScript reference

pub fn define_property_or_throw<K, P>( &self, key: K, desc: P, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>, P: Into<PropertyDescriptor>,

Define property or throw.

More information:

• ECMAScript reference

pub fn delete_property_or_throw<K>( &self, key: K, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>,

Defines the property or throws a TypeError if the operation fails.

More information:

• ECMAScript reference

pub fn has_property<K>(&self, key: K, context: &mut Context) -> JsResult<bool>

where K: Into<PropertyKey>,

Check if object has property.

More information:

• ECMAScript reference

pub fn has_own_property<K>( &self, key: K, context: &mut Context ) -> JsResult<bool>

where K: Into<PropertyKey>,

Check if object has an own property.

More information:

• ECMAScript reference

pub fn call( &self, this: &JsValue, args: &[JsValue], context: &mut Context ) -> JsResult<JsValue>

Call ( F, V [ , argumentsList ] )

Panics

Panics if the object is currently mutably borrowed.

More information:

• ECMAScript reference

pub fn construct( &self, args: &[JsValue], new_target: Option<&Self>, context: &mut Context ) -> JsResult<Self>

Construct ( F [ , argumentsList [ , newTarget ] ] )

Construct an instance of this object with the specified arguments.

Panics

Panics if the object is currently mutably borrowed.

More information:

• ECMAScript reference

pub fn set_integrity_level( &self, level: IntegrityLevel, context: &mut Context ) -> JsResult<bool>

Make the object sealed or frozen.

More information:

• ECMAScript reference

pub fn test_integrity_level( &self, level: IntegrityLevel, context: &mut Context ) -> JsResult<bool>

Check if the object is sealed or frozen.

More information:

• ECMAScript reference

Trait Implementations

impl Clone for JsDate

fn clone(&self) -> JsDate

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsDate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for JsDate

type Target = JsObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for JsDate

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for JsDate

fn finalize(&self)

Cleanup logic for a type.

impl From<JsDate> for JsObject

fn from(o: JsDate) -> Self

Converts to this type from the input type.

impl From<JsDate> for JsValue

fn from(o: JsDate) -> Self

Converts to this type from the input type.

impl Trace for JsDate

unsafe fn trace(&self, tracer: &mut Tracer)

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.

impl TryFromJs for JsDate

fn try_from_js(value: &JsValue, _context: &mut Context) -> JsResult<Self>

This function tries to convert a JavaScript value into Self.