TimeZoneFormatter.d.ts (8739B)
1 // generated by diplomat-tool 2 import type { DataProvider } from "./DataProvider" 3 import type { DateTimeFormatterLoadError } from "./DateTimeFormatterLoadError" 4 import type { DateTimeWriteError } from "./DateTimeWriteError" 5 import type { Locale } from "./Locale" 6 import type { TimeZoneInfo } from "./TimeZoneInfo" 7 import type { pointer, codepoint } from "./diplomat-runtime.d.ts"; 8 9 10 /** 11 * See the [Rust documentation for `NoCalendarFormatter`](https://docs.rs/icu/latest/icu/datetime/type.NoCalendarFormatter.html) for more information. 12 */ 13 14 15 export class TimeZoneFormatter { 16 get ffiValue(): pointer; 17 18 19 /** 20 * Creates a zoned formatter based on a non-zoned formatter. 21 * 22 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 23 * or else unexpected behavior may occur! 24 * 25 * See the [Rust documentation for `SpecificLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.SpecificLong.html) for more information. 26 */ 27 static createSpecificLong(locale: Locale): TimeZoneFormatter; 28 29 /** 30 * Creates a zoned formatter based on a non-zoned formatter. 31 * 32 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 33 * or else unexpected behavior may occur! 34 * 35 * See the [Rust documentation for `SpecificLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.SpecificLong.html) for more information. 36 */ 37 static createSpecificLongWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 38 39 /** 40 * Creates a zoned formatter based on a non-zoned formatter. 41 * 42 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 43 * or else unexpected behavior may occur! 44 * 45 * See the [Rust documentation for `SpecificShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.SpecificShort.html) for more information. 46 */ 47 static createSpecificShort(locale: Locale): TimeZoneFormatter; 48 49 /** 50 * Creates a zoned formatter based on a non-zoned formatter. 51 * 52 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 53 * or else unexpected behavior may occur! 54 * 55 * See the [Rust documentation for `SpecificShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.SpecificShort.html) for more information. 56 */ 57 static createSpecificShortWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 58 59 /** 60 * Creates a zoned formatter based on a non-zoned formatter. 61 * 62 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 63 * or else unexpected behavior may occur! 64 * 65 * See the [Rust documentation for `LocalizedOffsetLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.LocalizedOffsetLong.html) for more information. 66 */ 67 static createLocalizedOffsetLong(locale: Locale): TimeZoneFormatter; 68 69 /** 70 * Creates a zoned formatter based on a non-zoned formatter. 71 * 72 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 73 * or else unexpected behavior may occur! 74 * 75 * See the [Rust documentation for `LocalizedOffsetLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.LocalizedOffsetLong.html) for more information. 76 */ 77 static createLocalizedOffsetLongWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 78 79 /** 80 * Creates a zoned formatter based on a non-zoned formatter. 81 * 82 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 83 * or else unexpected behavior may occur! 84 * 85 * See the [Rust documentation for `LocalizedOffsetShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.LocalizedOffsetShort.html) for more information. 86 */ 87 static createLocalizedOffsetShort(locale: Locale): TimeZoneFormatter; 88 89 /** 90 * Creates a zoned formatter based on a non-zoned formatter. 91 * 92 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 93 * or else unexpected behavior may occur! 94 * 95 * See the [Rust documentation for `LocalizedOffsetShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.LocalizedOffsetShort.html) for more information. 96 */ 97 static createLocalizedOffsetShortWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 98 99 /** 100 * Creates a zoned formatter based on a non-zoned formatter. 101 * 102 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 103 * or else unexpected behavior may occur! 104 * 105 * See the [Rust documentation for `GenericLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.GenericLong.html) for more information. 106 */ 107 static createGenericLong(locale: Locale): TimeZoneFormatter; 108 109 /** 110 * Creates a zoned formatter based on a non-zoned formatter. 111 * 112 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 113 * or else unexpected behavior may occur! 114 * 115 * See the [Rust documentation for `GenericLong`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.GenericLong.html) for more information. 116 */ 117 static createGenericLongWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 118 119 /** 120 * Creates a zoned formatter based on a non-zoned formatter. 121 * 122 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 123 * or else unexpected behavior may occur! 124 * 125 * See the [Rust documentation for `GenericShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.GenericShort.html) for more information. 126 */ 127 static createGenericShort(locale: Locale): TimeZoneFormatter; 128 129 /** 130 * Creates a zoned formatter based on a non-zoned formatter. 131 * 132 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 133 * or else unexpected behavior may occur! 134 * 135 * See the [Rust documentation for `GenericShort`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.GenericShort.html) for more information. 136 */ 137 static createGenericShortWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 138 139 /** 140 * Creates a zoned formatter based on a non-zoned formatter. 141 * 142 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 143 * or else unexpected behavior may occur! 144 * 145 * See the [Rust documentation for `Location`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.Location.html) for more information. 146 */ 147 static createLocation(locale: Locale): TimeZoneFormatter; 148 149 /** 150 * Creates a zoned formatter based on a non-zoned formatter. 151 * 152 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 153 * or else unexpected behavior may occur! 154 * 155 * See the [Rust documentation for `Location`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.Location.html) for more information. 156 */ 157 static createLocationWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 158 159 /** 160 * Creates a zoned formatter based on a non-zoned formatter. 161 * 162 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 163 * or else unexpected behavior may occur! 164 * 165 * See the [Rust documentation for `ExemplarCity`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.ExemplarCity.html) for more information. 166 */ 167 static createExemplarCity(locale: Locale): TimeZoneFormatter; 168 169 /** 170 * Creates a zoned formatter based on a non-zoned formatter. 171 * 172 * Caution: The locale provided here must match the locale used to construct the non-zoned formatter, 173 * or else unexpected behavior may occur! 174 * 175 * See the [Rust documentation for `ExemplarCity`](https://docs.rs/icu/latest/icu/datetime/fieldsets/zone/struct.ExemplarCity.html) for more information. 176 */ 177 static createExemplarCityWithProvider(provider: DataProvider, locale: Locale): TimeZoneFormatter; 178 179 /** 180 * See the [Rust documentation for `format`](https://docs.rs/icu/latest/icu/datetime/struct.FixedCalendarDateTimeFormatter.html#method.format) for more information. 181 */ 182 format(zone: TimeZoneInfo): string; 183 }