Struct TimezoneOffset 

pub struct TimezoneOffset(/* private fields */);

A UTC offset in hours, the wire form of the record-listing timezone knob.

The getCDR, getResellerCDR, getSMS, getMMS, getResellerSMS, and getResellerMMS methods take a timezone parameter that VoIP.ms documents as “adjust the times of the records according to Timezone (Numeric: -12 to 13)”. It is a whole- or fractional-hour offset from UTC, not an IANA zone name – distinct from the getTimezones / voicemail timezone, which is a named zone (America/New_York). Passing -5 returns timestamps in UTC-05:00; omitting it leaves them in the account’s configured timezone.

Callers hold a chrono_tz::Tz on those methods’ timezone field; the crate resolves it to this offset at the query’s start date via TimezoneOffset::at before sending. Construct one directly only to bypass zone resolution and pin a fixed numeric offset.

Wraps a Decimal constrained to -12..=13. TimezoneOffset::new rejects out-of-range values so a nonsensical offset never reaches the wire.

Wire format

Serializes as a bare number (-5, 5.5); deserializes tolerantly from a JSON number or a numeric string.

Implementations

impl TimezoneOffset

pub fn new(hours: impl Into<Decimal>) -> Result<Self, TimezoneOffsetError>

Construct an offset, rejecting a value outside -12..=13 hours.

pub fn at(tz: Tz, date: NaiveDate) -> Result<Self, TimezoneOffsetError>

The UTC offset of tz on date, the value VoIP.ms wants for a query starting that day.

VoIP.ms takes a single numeric offset for a whole date range, but a zone’s offset shifts across DST boundaries, so the offset is fixed at one instant – local noon on date, chosen to sit clear of the midnight DST fold. A zone whose offset exceeds -12..=13 (e.g. Pacific/Kiritimati, +14) has no VoIP.ms representation and returns TimezoneOffsetError::OutOfRange.

pub fn hours(&self) -> Decimal

The offset in hours from UTC.

Trait Implementations

impl Clone for TimezoneOffset

fn clone(&self) -> TimezoneOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TimezoneOffset

impl Debug for TimezoneOffset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TimezoneOffset

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TimezoneOffset

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

Renders the offset as a signed UTC±HH:MM label (UTC-05:00).

impl Eq for TimezoneOffset

impl FromStr for TimezoneOffset

type Err = TimezoneOffsetError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for TimezoneOffset

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TimezoneOffset

fn cmp(&self, other: &TimezoneOffset) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TimezoneOffset

fn eq(&self, other: &TimezoneOffset) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for TimezoneOffset

fn partial_cmp(&self, other: &TimezoneOffset) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TimezoneOffset

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimezoneOffset

impl TryFrom<i64> for TimezoneOffset

type Error = TimezoneOffsetError

The type returned in the event of a conversion error.

fn try_from(hours: i64) -> Result<Self, Self::Error>

Performs the conversion.