siderust 0.6.0

High-precision astronomy and satellite mechanics in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! Satellite type and related functionality.
//!
//! Represents natural or artificial satellites with name, mass, radius, and orbital parameters.
//! - `name`: Name of the satellite (borrowed or owned).
//! - `mass`: Mass in kilograms (`Kilograms`).
//! - `radius`: Mean radius in kilometers (`Kilometers`).
//! - `orbit`: Orbital parameters (see [`Orbit`]).

use crate::astro::orbit::Orbit;
use qtty::{Kilograms, Kilometers};

use std::borrow::Cow;

#[derive(Clone, Debug)]
/// Represents a **Satellite** characterized by its mass, radius and orbit.
pub struct Satellite<'a> {
    pub name: Cow<'a, str>,
    pub mass: Kilograms,
    pub radius: Kilometers,
    pub orbit: Orbit,
}

impl<'a> Satellite<'a> {
    /// Compile‐time constructor: only works with `'static` string literals.
    pub const fn new_const(
        name: &'static str,
        mass: Kilograms,
        radius: Kilometers,
        orbit: Orbit,
    ) -> Satellite<'static> {
        Satellite {
            name: Cow::Borrowed(name),
            mass,
            radius,
            orbit,
        }
    }

    /// Runtime constructor: accepts any string-like thing.
    pub fn new<N>(name: N, mass: Kilograms, radius: Kilometers, orbit: Orbit) -> Satellite<'a>
    where
        N: Into<Cow<'a, str>>,
    {
        Satellite {
            name: name.into(),
            mass,
            radius,
            orbit,
        }
    }
}