Struct ZmanPreset 

pub struct ZmanPreset {
    pub event: ZmanPrimitive,
    pub method_name: &'static str,
    pub name: &'static str,
    pub deprecated: bool,
    /* private fields */
}

A named zman preset backed by a low-level ZmanPrimitive.

Most callers should use presets directly instead of constructing ZmanPrimitive values themselves.

Fields

event: ZmanPrimitive

The primitive calculation used by this preset.

method_name: &'static str

The KosherJava getter name (for example getSunrise).

name: &'static str

The user-facing preset name.

deprecated: bool

Whether KosherJava marks this preset as deprecated.

Implementations

impl ZmanPreset

pub fn description(&self, calculator: &ZmanimCalculator) -> String

Returns a user-facing preset description.

The description includes active ZmanimCalculator settings when they affect how this preset is calculated.

Requires the alloc feature.

Trait Implementations

impl Clone for ZmanPreset

fn clone(&self) -> ZmanPreset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZmanPreset

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

Formats the value using the given formatter.

impl Format for ZmanPreset

Available on crate feature defmt only.

fn format(&self, fmt: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl ZmanLike for ZmanPreset

fn calculate( &self, calculator: &ZmanimCalculator, ) -> Result<Timestamp, ZmanimError>

Calculates this zman with the given calculator.