Struct SpaceTrackQuery 

pub struct SpaceTrackQuery { /* private fields */ }

Builder for constructing SpaceTrack API queries.

Uses a fluent API where each method returns Self to allow method chaining. Call build() to produce the URL path string.

Examples

use brahe::spacetrack::{SpaceTrackQuery, RequestClass, SortOrder, OutputFormat};

// Query latest GP data for ISS
let query = SpaceTrackQuery::new(RequestClass::GP)
    .filter("NORAD_CAT_ID", "25544")
    .order_by("EPOCH", SortOrder::Desc)
    .limit(1);

let url_path = query.build();
assert!(url_path.contains("/class/gp/"));
assert!(url_path.contains("/NORAD_CAT_ID/25544/"));

// Query with custom format
let query = SpaceTrackQuery::new(RequestClass::GP)
    .filter("NORAD_CAT_ID", "25544")
    .format(OutputFormat::TLE);

let url_path = query.build();
assert!(url_path.contains("/format/tle"));

Implementations

impl SpaceTrackQuery

pub fn new(class: RequestClass) -> Self

Create a new query builder for the specified request class.

Uses the default controller for the request class.

Arguments

• class - The request class to query

Examples

use brahe::spacetrack::{SpaceTrackQuery, RequestClass};

let query = SpaceTrackQuery::new(RequestClass::GP);

pub fn controller(self, controller: RequestController) -> Self

Override the default controller for this query.

Most users will not need to call this method, as each request class has an appropriate default controller.

Arguments

• controller - The controller to use

pub fn filter(self, field: &str, value: &str) -> Self

Add a filter predicate to the query.

Filters restrict the results to records where the specified field matches the given value. Use operator functions from the operators module to construct comparison values (e.g., operators::greater_than("25544")).

Arguments

• field - The field name (e.g., “NORAD_CAT_ID”, “EPOCH”)
• value - The filter value, optionally with operator prefix

Examples

use brahe::spacetrack::{SpaceTrackQuery, RequestClass, operators};

let query = SpaceTrackQuery::new(RequestClass::GP)
    .filter("NORAD_CAT_ID", "25544")
    .filter("EPOCH", &operators::greater_than("2024-01-01"));

pub fn order_by(self, field: &str, order: SortOrder) -> Self

Add an ordering clause to the query.

Multiple order_by calls are cumulative - records are sorted by the first field, then by subsequent fields for ties.

Arguments

• field - The field to sort by
• order - The sort direction (ascending or descending)

Examples

use brahe::spacetrack::{SpaceTrackQuery, RequestClass, SortOrder};

let query = SpaceTrackQuery::new(RequestClass::GP)
    .order_by("EPOCH", SortOrder::Desc);

pub fn limit(self, count: u32) -> Self

Set the maximum number of results to return.

Arguments

• count - Maximum number of records

pub fn limit_offset(self, count: u32, offset: u32) -> Self

Set the maximum number of results and an offset.

Arguments

• count - Maximum number of records
• offset - Number of records to skip

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

Set the output format for query results.

If not specified, defaults to JSON.

Arguments

• format - The desired output format

pub fn predicates_filter(self, fields: &[&str]) -> Self

Specify which fields to include in the response.

This is a predicates filter that limits which fields are returned for each record. Useful for reducing response size.

Arguments

• fields - Slice of field names to include

pub fn metadata(self, enabled: bool) -> Self

Enable or disable metadata in the response.

When enabled, the response includes query metadata (e.g., total count).

Arguments

• enabled - Whether to include metadata

pub fn distinct(self, enabled: bool) -> Self

Enable or disable distinct results.

When enabled, duplicate records are removed from the results.

Arguments

• enabled - Whether to return distinct results

pub fn empty_result(self, enabled: bool) -> Self

Enable or disable empty result return.

When enabled, an empty query (no results) returns an empty array/set instead of an error response.

Arguments

• enabled - Whether to allow empty results

pub fn favorites(self, favorites: &str) -> Self

Set a favorites filter for the query.

Arguments

• favorites - The favorites identifier

pub fn build(&self) -> String

Build the URL path string for this query.

Produces the path portion of the Space-Track API URL, which should be appended to the base URL and authentication endpoint.

Returns

• String - The URL path string for this query

Examples

use brahe::spacetrack::{SpaceTrackQuery, RequestClass, SortOrder};

let query = SpaceTrackQuery::new(RequestClass::GP)
    .filter("NORAD_CAT_ID", "25544")
    .order_by("EPOCH", SortOrder::Desc)
    .limit(1);

let path = query.build();
assert_eq!(
    path,
    "/basicspacedata/query/class/gp/NORAD_CAT_ID/25544/orderby/EPOCH%20desc/limit/1/format/json"
);

pub fn output_format(&self) -> OutputFormat

Returns the output format for this query.

Returns OutputFormat::JSON if no format has been explicitly set.

pub fn request_class(&self) -> RequestClass

Returns the request class for this query.

Trait Implementations

impl Clone for SpaceTrackQuery

fn clone(&self) -> SpaceTrackQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpaceTrackQuery

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

Formats the value using the given formatter.