Skip to main content

ElectionCriteria

Struct ElectionCriteria 

Source
pub struct ElectionCriteria {
    pub purpose: Purpose,
    pub avoid_void_moon: bool,
    pub avoid_mercury_retrograde: Option<bool>,
    pub avoid_venus_retrograde: Option<bool>,
    pub daytime_only: bool,
    pub local_hours: Option<HourRange>,
    pub utc_offsets: Vec<UtcOffset>,
    pub step_minutes: u32,
    pub min_score: f64,
    pub max_results: usize,
    pub natal: Option<Vec<NatalPoint>>,
}
Expand description

What to look for. Every field has a default, so {} is a valid criteria object.

Fields§

§purpose: Purpose

What the election is for.

§avoid_void_moon: bool

Leave out moments when the Moon is void of course (default true).

§avoid_mercury_retrograde: Option<bool>

Leave out moments when Mercury is retrograde (default: when the purpose fears it).

§avoid_venus_retrograde: Option<bool>

Leave out moments when Venus is retrograde (default: when the purpose fears it).

§daytime_only: bool

Leave out moments between sunset and sunrise.

§local_hours: Option<HourRange>

Only moments within these local clock hours.

§utc_offsets: Vec<UtcOffset>

UTC offsets of local time for local_hours (none: local time is UTC).

§step_minutes: u32

Minutes between the moments a search assesses (5-60, default 10).

§min_score: f64

Lowest score a search keeps (default 60).

§max_results: usize

Most windows a search returns (1-50, default 20).

§natal: Option<Vec<NatalPoint>>

The natal chart to elect for, if any.

Implementations§

Source§

impl ElectionCriteria

Source

pub fn from_value(value: &Value) -> Result<Self, EngineError>

Criteria from a JSON object (null gives the defaults).

Trait Implementations§

Source§

impl Clone for ElectionCriteria

Source§

fn clone(&self) -> Self

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 ElectionCriteria

Source§

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

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

impl Default for ElectionCriteria

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for ElectionCriteria

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ElectionCriteria

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ElectionCriteria

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ElectionCriteria

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.