Enum Query 

pub enum Query {
    AllWithinField,
    NearestOne,
    NearestN {
        n: usize,
        max_radius: Option<Angle>,
    },
}

What to return from a match.

Set on a Constraint via Constraint::all, Constraint::nearest_one, Constraint::nearest_n, or Constraint::nearest_n_within.

Example

use skymath::{Angle, Equatorial, ParseMode};
use target_match::{rank, Constraint, SkyObject};

struct Target {
    ra: f64,
    dec: f64,
}
impl SkyObject for Target {
    fn position(&self) -> Equatorial {
        Equatorial::j2000(Angle::from_degrees(self.ra), Angle::from_degrees(self.dec)).unwrap()
    }
}

let catalog = [Target { ra: 10.6847, dec: 41.2688 }];
let pointing = Equatorial::parse_j2000("00:42:44.3", "+41:16:09", ParseMode::Strict).unwrap();

// `nearest_n(1)` sets the query to `Query::NearestN { n: 1, .. }`.
let hits = rank(pointing, &catalog, Constraint::circular(Angle::from_degrees(1.0)).nearest_n(1));
assert_eq!(hits.len(), 1);

Variants

AllWithinField

Every object inside the membership shape, ranked nearest-first.

NearestOne

The single nearest in-frame object.

NearestN

The n nearest objects by separation, optionally bounded by a radius.

Fields

n: usize

Maximum number of results.

max_radius: Option<Angle>

Optional maximum separation; unbounded when None.

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Query

impl Debug for Query

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Query

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Query

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Query

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 Query