Skip to main content

TimestamperBuilder

Struct TimestamperBuilder 

Source
pub struct TimestamperBuilder { /* private fields */ }
Expand description

Builder for Timestamper. Every chain method is #[must_use] so silent misuse is caught at compile time. build() performs post-configuration validation and returns the same typed errors the CLI’s post-parse validation produces (e.g., Error::InvalidUtcWithNamedTz for FR-020 mirrored at the library layer).

§Example

use rusty_ts::{TimestamperBuilder, Format, TimezoneSource};

// Configure via the structured `utc()` / `tz_name()` methods that mirror
// the CLI `-u` and `--tz=<IANA>` flags.
let ts = TimestamperBuilder::new()
    .format(Format::Strftime("%Y-%m-%d %H:%M:%S".into()))
    .utc(true)
    .build()
    .expect("valid configuration");

// Conflicting configuration is caught at build() per FR-020.
let result = TimestamperBuilder::new()
    .utc(true)
    .tz_name("Asia/Tokyo")
    .build();
assert!(result.is_err());

Implementations§

Source§

impl TimestamperBuilder

Source

pub fn new() -> Self

Start a new builder with all-default configuration.

Source

pub fn format(self, format: Format) -> Self

Set the strftime format selector.

Source

pub fn utc(self, utc: bool) -> Self

Request UTC rendering (mirrors the CLI -u / --utc flag). Conflicts with tz_name; combined use causes build() to return Error::InvalidUtcWithNamedTz per FR-020.

Source

pub fn tz_name(self, name: impl Into<String>) -> Self

Request rendering in a named IANA timezone (mirrors the CLI --tz=<IANA> flag). Conflicts with utc(true). The name is resolved at build() time; an unrecognised name produces Error::InvalidIanaName.

Source

pub fn timezone(self, tz: TimezoneSource) -> Self

Low-level escape hatch: set the timezone source directly. When set, overrides utc() and tz_name() configuration. Most callers should prefer the structured utc() / tz_name() methods, which mirror the CLI flag surface and provide the FR-020 mutex enforcement.

Source

pub fn compat(self, mode: CompatibilityMode) -> Self

Set the compatibility mode. Default is CompatibilityMode::Default.

Source

pub fn elapsed(self, anchor: ElapsedAnchor) -> Self

Set the elapsed-time anchor. Default is Absolute.

Source

pub fn build(self) -> Result<Timestamper, Error>

Finalize the builder. Returns a configured Timestamper or an Error if the configuration is invalid.

Validation:

  • utc(true) + tz_name(...) together → Error::InvalidUtcWithNamedTz (library-layer mirror of FR-020).
  • tz_name("...") with unrecognised IANA name → Error::InvalidIanaName.
  • timezone(...) low-level override bypasses the above and uses whatever variant was supplied directly.

Trait Implementations§

Source§

impl Clone for TimestamperBuilder

Source§

fn clone(&self) -> TimestamperBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TimestamperBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TimestamperBuilder

Source§

fn default() -> TimestamperBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.