SwiftNav

https://docs.rs/swiftnav/latest/swiftnav/
Admin
SwiftNav is a Rust library that implements GNSS utility functions for position estimation using raw...
Tokens:117,912
Snippets:1,374
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Create and Use GnssSignal - Rust

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/index.html

Demonstrates creating a `GnssSignal` instance and verifying its properties. Also shows how to get the satellite count for a constellation and parse a `Code` string.

```rust
let sid = GnssSignal::new(22, Code::GpsL1ca).unwrap();

assert_eq!(sid.to_constellation(), Constellation::Gps);
assert_eq!(sid.to_string(), "GPS L1CA 22");

assert_eq!(Constellation::Gal.sat_count(), 36);

let code = Code::from_str("BDS3 B1C").unwrap();
assert_eq!(code.get_carrier_frequency(), 1575.42e6);
```

--------------------------------

### ReferenceFrame Usage Examples

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/enum.ReferenceFrame.html

Demonstrates how to use the ReferenceFrame enum, including selecting predefined frames, parsing from strings, and creating custom frames.

```APIDOC
// Use predefined frames
let itrf = ReferenceFrame::ITRF2020;
let nad83 = ReferenceFrame::NAD83_2011;

// Parse from string
let parsed: ReferenceFrame = "ITRF2014".parse()?;
let custom: ReferenceFrame = "MY_LOCAL_FRAME".parse()?;

// Custom frames
let local = ReferenceFrame::Other("SITE_FRAME_2023".to_string());
```

--------------------------------

### NMEA GGA Sentence Format Example

Source: https://docs.rs/swiftnav/latest/swiftnav/nmea/struct.GGA.html

Illustrates the standard NMEA 0183 GGA sentence format. This is a reference for understanding the structure of GGA data transmitted over serial interfaces.

```text
       1         2       3 4        5 6 7  8   9  10 |  12 13  14   15
       |         |       | |        | | |  |   |   | |   | |   |    |
 $--GGA,hhmmss.ss,ddmm.mm,a,ddmm.mm,a,x,xx,x.x,x.x,M,x.x,M,x.x,xxxx*hh<CR><LF>
```

--------------------------------

### LLHDegrees From Implementations

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHDegrees.html

Demonstrates how to create LLHDegrees from various other types.

```APIDOC
## LLHDegrees From Implementations

### Description
Provides implementations for creating `LLHDegrees` from different data types, enabling flexible initialization.

### Implementations

#### `From<&[f64; 3]>`
* **Description**: Creates an `LLHDegrees` from a slice of 3 `f64` values (latitude, longitude, height).
* **Signature**: `fn from(array: &[f64; 3]) -> Self`

#### `From<[f64; 3]>`
* **Description**: Creates an `LLHDegrees` from an array of 3 `f64` values (latitude, longitude, height).
* **Signature**: `fn from(array: [f64; 3]) -> Self`

#### `From<(f64, f64, f64)>`
* **Description**: Creates an `LLHDegrees` from a tuple of three `f64` values (latitude, longitude, height).
* **Signature**: `fn from((x, y, z): (f64, f64, f64)) -> Self`

#### `From<ECEF>`
* **Description**: Creates an `LLHDegrees` from an `ECEF` coordinate representation.
* **Signature**: `fn from(ecef: ECEF) -> Self`

#### `From<LLHRadians>`
* **Description**: Creates an `LLHDegrees` from an `LLHRadians` coordinate representation.
* **Signature**: `fn from(rad: LLHRadians) -> Self`

#### `From<Vector3<f64>>`
* **Description**: Creates an `LLHDegrees` from a `Vector3<f64>`.
* **Signature**: `fn from(vector: Vector3<f64>) -> Self`
```

--------------------------------

### Get MJD as f64

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.MJD.html

Gets the floating-point value of the modified julian date.

```rust
pub fn as_f64(&self) -> f64
```

--------------------------------

### type_id

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Gets the `TypeId` of `self`.

```APIDOC
## fn type_id(&self) -> TypeId

### Description
Gets the `TypeId` of `self`.

### Method
`type_id`

### Parameters
None

### Returns
`TypeId` - The unique identifier for the type of `self`.
```

--------------------------------

### Create TransformationRepository from a list

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Initialize a repository with a collection of `Transformation` objects. If duplicates exist, the last one in the list takes precedence.

```rust
pub fn from_transformations<T: IntoIterator<Item = Transformation>>( transformations: T, ) -> Self
```

--------------------------------

### Get Constellation

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.GnssSignal.html

Determines and returns the Constellation of the GnssSignal.

```rust
pub fn to_constellation(self) -> Constellation
```

--------------------------------

### take

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.ConstellationIter.html

Creates an iterator that yields the first `n` elements.

```APIDOC
## take(self, n: usize) -> Take<Self>

### Description
Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.

### Parameters
#### Path Parameters
- **n** (usize) - Required - The maximum number of elements to yield.

### Returns
- **Take<Self>** - An iterator that yields at most `n` elements.
```

--------------------------------

### ECEF::y

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets the Y component of the ECEF coordinates.

```APIDOC
## `ECEF::y`

### Description
Get the Y component.

### Method
```rust
pub fn y(&self) -> f64
```
```

--------------------------------

### NED::d

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets the down component of the NED coordinates.

```APIDOC
## pub fn d(&self) -> f64

### Description
Get the down component

### Returns
- f64 - The down component.
```

--------------------------------

### Basic Usage: Transforming Coordinates

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/index.html

Demonstrates how to initialize a transformation repository with built-in parameters, create a coordinate with position and velocity, and transform it to a different reference frame.

```APIDOC
## Basic Usage: Transforming Coordinates

This example shows how to perform a basic coordinate transformation between two reference frames using the `TransformationRepository`.

### Method
```rust
use swiftnav::{
    coords::{Coordinate, ECEF},
    reference_frame::{TransformationRepository, ReferenceFrame},
    time::UtcTime
};

let repo = TransformationRepository::from_builtin();
let epoch = UtcTime::from_parts(2020, 3, 15, 0, 0, 0.).to_gps_hardcoded();

// Create coordinate with position and velocity
let itrf_coord = Coordinate::with_velocity(
    ReferenceFrame::ITRF2014,
    ECEF::new(-2703764.0, -4261273.0, 3887158.0),
    ECEF::new(-0.221, 0.254, 0.122),
    epoch
);

// Transform to different reference frame
let nad83_coord = repo.transform(&itrf_coord, &ReferenceFrame::NAD83_2011)?;
```
```

--------------------------------

### Get down component

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Retrieves the down component of the NED coordinates.

```rust
pub fn d(&self) -> f64
```

--------------------------------

### Get Signal Code

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.GnssSignal.html

Retrieves the Code associated with the GnssSignal.

```rust
pub fn code(&self) -> Code
```

--------------------------------

### Create an empty TransformationRepository

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Use this to create a new, empty repository. No transformations are loaded initially.

```rust
pub fn new() -> Self
```

--------------------------------

### TransformationRepository::count

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Get the number of transformations stored in the repository.

```APIDOC
## TransformationRepository::count

### Description
Get the number of transformations stored in the repository.

### Method
```rust
pub fn count(&self) -> usize
```
```

--------------------------------

### Comparison Methods

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHRadians.html

Provides methods for comparing LLHRadians instances.

```APIDOC
## fn gt(&self, other: &Rhs) -> bool

Tests greater than (for `self` and `other`) and is used by the `>` operator.

### Parameters
- `other`: The other `Rhs` value to compare against.

### Returns
- `bool`: True if `self` is greater than `other`, false otherwise.

### Example
```rust
let radians1 = LLHRadians { ... };
let radians2 = LLHRadians { ... };
let is_greater = radians1.gt(&radians2);
```
```

```APIDOC
## fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator.

### Parameters
- `other`: The other `Rhs` value to compare against.

### Returns
- `bool`: True if `self` is greater than or equal to `other`, false otherwise.

### Example
```rust
let radians1 = LLHRadians { ... };
let radians2 = LLHRadians { ... };
let is_greater_equal = radians1.ge(&radians2);
```
```

--------------------------------

### Create TransformationRepository with built-in transformations

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Instantiate a repository pre-populated with all the standard, built-in transformations.

```rust
pub fn from_builtin() -> Self
```

--------------------------------

### ECEF::z

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets the Z component of the ECEF coordinates.

```APIDOC
## `ECEF::z`

### Description
Get the Z component.

### Method
```rust
pub fn z(&self) -> f64
```
```

--------------------------------

### fn take(self, n: usize) -> Take<Self>

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.ReferenceFrameIter.html

Creates an iterator that yields the first `n` elements.

```APIDOC
## fn take(self, n: usize) -> Take<Self>

### Description
Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.

### Parameters
- **n**: The maximum number of elements to yield.

### Returns
A new iterator of type `Take<Self>`.
```

--------------------------------

### ECEF::x

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets the X component of the ECEF coordinates.

```APIDOC
## `ECEF::x`

### Description
Get the X component.

### Method
```rust
pub fn x(&self) -> f64
```
```

--------------------------------

### TransformationRepository::new

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Create an empty transformation repository.

```APIDOC
## TransformationRepository::new

### Description
Create an empty transformation repository.

### Method
```rust
pub fn new() -> Self
```
```

--------------------------------

### NED::e

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets the east component of the NED coordinates.

```APIDOC
## pub fn e(&self) -> f64

### Description
Get the east component

### Returns
- f64 - The east component.
```

--------------------------------

### GGABuilder Conversion Traits

Source: https://docs.rs/swiftnav/latest/swiftnav/nmea/struct.GGABuilder.html

Documentation for `TryFrom` and `TryInto` trait implementations for GGABuilder.

```APIDOC
## impl<T, U> TryFrom<U> for T

where U: Into<T>

### type Error = Infallible

Description: The type returned in the event of a conversion error.

### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Description: Performs the conversion.
```

```APIDOC
## impl<T, U> TryInto<U> for T

where U: TryFrom<T>

### type Error = <U as TryFrom<T>>::Error

Description: The type returned in the event of a conversion error.

### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Description: Performs the conversion.
```

--------------------------------

### NED::n

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets the north component of the NED coordinates.

```APIDOC
## pub fn n(&self) -> f64

### Description
Get the north component

### Returns
- f64 - The north component.
```

--------------------------------

### Get Coordinate Epoch

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.Coordinate.html

Retrieves the `GpsTime` epoch of the `Coordinate`.

```rust
pub fn epoch(&self) -> GpsTime
```

--------------------------------

### TransformationRepository::from_builtin

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Create a repository with the builtin transformations.

```APIDOC
## TransformationRepository::from_builtin

### Description
Create a repository with the builtin transformations.

### Method
```rust
pub fn from_builtin() -> Self
```
```

--------------------------------

### GGABuilder build() Method

Source: https://docs.rs/swiftnav/latest/swiftnav/nmea/struct.GGABuilder.html

Finishes the building process and returns the constructed GGA object. Requires the state S to be IsComplete.

```rust
pub fn build(self) -> GGA
where S: IsComplete,
```

--------------------------------

### Get Coordinate Position

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.Coordinate.html

Retrieves the `ECEF` position of the `Coordinate`.

```rust
pub fn position(&self) -> ECEF
```

--------------------------------

### unsafe fn clone_to_uninit

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.GnssSignal.html

This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

### Safety
This function is unsafe and requires the caller to ensure that `dest` is a valid, mutable pointer to a buffer of sufficient size to hold the contents of `self`.
```

--------------------------------

### BDS_TIME_START

Source: https://docs.rs/swiftnav/latest/swiftnav/time/constant.BDS_TIME_START.html

Represents the GPS timestamp of the start of Beidou time.

```APIDOC
## Constant BDS_TIME_START

### Summary
```
pub const BDS_TIME_START: GpsTime;
```

### Description
GPS timestamp of the start of Beidou time
```

--------------------------------

### Get Time of Week

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.GalTime.html

Retrieves the time of week from a GalTime object.

```rust
pub fn tow(&self) -> f64
```

--------------------------------

### Custom Transformations: Adding a New Transformation

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/index.html

Illustrates how to create a custom transformation and add it to the `TransformationRepository`.

```APIDOC
## Custom Transformations: Adding a New Transformation

This example demonstrates how to define and add a custom transformation to the repository.

### Method
```rust
use swiftnav::reference_frame::{TransformationRepository, ReferenceFrame, Transformation, TimeDependentHelmertParams};

let mut repo = TransformationRepository::new();

let custom_transform = Transformation {
    from: ReferenceFrame::ITRF2020,
    to: ReferenceFrame::Other("LOCAL_FRAME".to_string()),
    params: TimeDependentHelmertParams::default(),
};

repo.add_transformation(custom_transform);
```
```

--------------------------------

### Comparison Methods

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHDegrees.html

Methods for comparing LLHDegrees instances.

```APIDOC
## fn partial_cmp(&self, other: &LLHDegrees) -> Option<Ordering>

### Description
This method returns an ordering between `self` and `other` values if one exists.

### Method
`partial_cmp`

### Parameters
#### Path Parameters
- **other** (`&LLHDegrees`) - Required - The other LLHDegrees value to compare against.

### Response
#### Success Response
- **Option<Ordering>** - An `Ordering` enum variant (`Less`, `Equal`, `Greater`) if the values are comparable, otherwise `None`.
```

```APIDOC
## fn lt(&self, other: &Rhs) -> bool

### Description
Tests less than (`<`) for `self` and `other`.

### Method
`lt`

### Parameters
#### Path Parameters
- **other** (`&Rhs`) - Required - The other value to compare against.

### Response
#### Success Response
- **bool** - `true` if `self` is less than `other`, `false` otherwise.
```

```APIDOC
## fn le(&self, other: &Rhs) -> bool

### Description
Tests less than or equal to (`<=`) for `self` and `other`.

### Method
`le`

### Parameters
#### Path Parameters
- **other** (`&Rhs`) - Required - The other value to compare against.

### Response
#### Success Response
- **bool** - `true` if `self` is less than or equal to `other`, `false` otherwise.
```

```APIDOC
## fn gt(&self, other: &Rhs) -> bool

### Description
Tests greater than (`>`) for `self` and `other`.

### Method
`gt`

### Parameters
#### Path Parameters
- **other** (`&Rhs`) - Required - The other value to compare against.

### Response
#### Success Response
- **bool** - `true` if `self` is greater than `other`, `false` otherwise.
```

```APIDOC
## fn ge(&self, other: &Rhs) -> bool

### Description
Tests greater than or equal to (`>=`) for `self` and `other`.

### Method
`ge`

### Parameters
#### Path Parameters
- **other** (`&Rhs`) - Required - The other value to compare against.

### Response
#### Success Response
- **bool** - `true` if `self` is greater than or equal to `other`, `false` otherwise.
```

--------------------------------

### Get Week Number

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.GalTime.html

Retrieves the week number from a GalTime object.

```rust
pub fn wn(&self) -> i16
```

--------------------------------

### Get east component

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Retrieves the east component of the NED coordinates.

```rust
pub fn e(&self) -> f64
```

--------------------------------

### take

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.

```APIDOC
## fn take(self, n: usize) -> Take<Self>
where Self: Sized,
Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner. Read more
1.0.0 · Source
```

--------------------------------

### Experimental Error Provide Method

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.InvalidCodeInt.html

Implements the nightly-only experimental `provide` method for error reporting.

```rust
impl Error for InvalidCodeInt {
    fn provide<'a>(&'a self, request: &mut Request<'a>) { ... }
}
```

--------------------------------

### Get north component

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Retrieves the north component of the NED coordinates.

```rust
pub fn n(&self) -> f64
```

--------------------------------

### MJD::as_f64

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.MJD.html

Gets the floating point value of the modified julian date.

```APIDOC
## MJD::as_f64

### Description
Gets the floating point value of the modified julian date.

### Signature
```rust
pub fn as_f64(&self) -> f64
```
```

--------------------------------

### TryFrom

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Enables fallible conversion from one type to another.

```APIDOC
## impl<T, U> TryFrom<U> for T

### Description
Enables fallible conversion from one type to another.

#### type Error = Infallible

### Description
The type returned in the event of a conversion error.

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

### Description
Performs the conversion.

### Signature
`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`
```

--------------------------------

### NED::as_vector

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets a reference to the inner `Vector3` storing the NED data.

```APIDOC
## pub fn as_vector(&self) -> &Vector3<f64>

### Description
Get a reference to the inner `Vector3` storing the data

### Returns
- &Vector3<f64> - A reference to the Vector3 object.
```

--------------------------------

### NED::as_array

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets a reference to the inner array storing the NED data.

```APIDOC
## pub fn as_array(&self) -> &[f64; 3]

### Description
Get a reference to the inner array storing the data

### Returns
- &[f64; 3] - A reference to the 3-element f64 array.
```

--------------------------------

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/swiftnav/latest/swiftnav/nmea/enum.GPSQuality.html

Nightly-only experimental API for copying data to uninitialized memory.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### GGA Implementations

Source: https://docs.rs/swiftnav/latest/swiftnav/nmea/struct.GGA.html

Provides methods for creating and converting GGA data.

```APIDOC
## Implementations

### impl GGA
- `builder()`: Create an instance of `GGA` using the builder syntax.
- `to_sentence()`: Converts the GGA struct into an NMEA sentence.
```

--------------------------------

### Get Coordinate Reference Frame

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.Coordinate.html

Retrieves a reference to the `ReferenceFrame` associated with the `Coordinate`.

```rust
pub fn reference_frame(&self) -> &ReferenceFrame
```

--------------------------------

### Cloning and Ownership Methods

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHDegrees.html

Methods for cloning, creating owned data, and copying.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
🔬This is a nightly-only experimental API. Performs copy-assignment from `self` to `dest`.

### Method
`clone_to_uninit`

### Parameters
#### Path Parameters
- **dest** (`*mut u8`) - Required - A mutable pointer to the destination memory.

### Safety
This function is unsafe and requires `unsafe` block. The caller must ensure that `dest` is valid for writes and points to enough memory to hold a `LLHDegrees` value.
```

```APIDOC
## fn to_owned(&self) -> T

### Description
Creates owned data from borrowed data, usually by cloning.

### Method
`to_owned`

### Response
#### Success Response
- **T** - An owned version of the data.
```

```APIDOC
## fn clone_into(&self, target: &mut T)

### Description
Uses borrowed data to replace owned data, usually by cloning.

### Method
`clone_into`

### Parameters
#### Path Parameters
- **target** (`&mut T`) - Required - A mutable reference to the owned data to be replaced.
```

--------------------------------

### Get Satellite PRN

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.GnssSignal.html

Retrieves the satellite Pseudo-Random Noise (PRN) number from the GnssSignal.

```rust
pub fn sat(&self) -> u16
```

--------------------------------

### Generic Blanket Implementations

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.InvalidCodeInt.html

Demonstrates generic blanket implementations for traits like Any, Borrow, BorrowMut, CloneToUninit, and From.

```rust
impl<T> Any for T where T: 'static + ?Sized { fn type_id(&self) -> TypeId { ... } }
```

```rust
impl<T> Borrow<T> for T where T: ?Sized { fn borrow(&self) -> &T { ... } }
```

```rust
impl<T> BorrowMut<T> for T where T: ?Sized { fn borrow_mut(&mut self) -> &mut T { ... } }
```

```rust
impl<T> CloneToUninit for T where T: Clone { unsafe fn clone_to_uninit(&self, dest: *mut u8) { ... } }
```

```rust
impl<T> From<T> for T {}
```

--------------------------------

### ECEF::as_vector

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets a reference to the inner `Vector3<f64>` storing the ECEF data.

```APIDOC
## `ECEF::as_vector`

### Description
Get a reference to the inner `Vector3` storing the data.

### Method
```rust
pub fn as_vector(&self) -> &Vector3<f64>
```
```

--------------------------------

### NED::as_vector_mut

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets a mutable reference to the inner `Vector3` storing the NED data.

```APIDOC
## pub fn as_vector_mut(&mut self) -> &mut Vector3<f64>

### Description
Get a mutable reference to the inner `Vector3` storing the data

### Returns
- &mut Vector3<f64> - A mutable reference to the Vector3 object.
```

--------------------------------

### fn partition<B, F>(self, f: F) -> (B, B)

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.ReferenceFrameIter.html

Consumes an iterator and creates two collections based on a predicate.

```APIDOC
## fn partition<B, F>(self, f: F) -> (B, B)

### Description
Consumes an iterator, creating two collections from it.

### Parameters
- **f**: A closure that takes a reference to an element and returns a boolean.

### Returns
A tuple containing two collections of type `B`.
```

--------------------------------

### clone_to_uninit

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Performs copy-assignment from self to a raw destination pointer. This is an experimental, nightly-only API.

```APIDOC
## unsafe fn clone_to_uninit(&self, dest: *mut u8)

### Description
Performs copy-assignment from `self` to `dest`.

### Method
`clone_to_uninit`

### Parameters
- `self`: A reference to the value to be cloned.
- `dest`: A raw pointer to the destination memory.

### Safety
This function is unsafe because it operates on raw pointers and assumes the destination is valid and has enough space.
```

--------------------------------

### NED::as_array_mut

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Gets a mutable reference to the inner array storing the NED data.

```APIDOC
## pub fn as_array_mut(&mut self) -> &mut [f64; 3]

### Description
Get a mutable reference to the inner array storing the data

### Returns
- &mut [f64; 3] - A mutable reference to the 3-element f64 array.
```

--------------------------------

### Get the number of transformations

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Returns the total count of transformations currently stored within the repository.

```rust
pub fn count(&self) -> usize
```

--------------------------------

### fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.ReferenceFrameIter.html

Calls a function for each contiguous window of size N over the iterator and returns an iterator over the results.

```APIDOC
## fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

### Description
Calls the given function `f` for each contiguous window of size `N` over `self` and returns an iterator over the outputs of `f`. Like `slice::windows()`, the windows during mapping overlap as well.

### Parameters
- **f**: A closure that takes a slice representing the window and returns a value.

### Returns
A new iterator of type `MapWindows<Self, F, N>`.

### Note
This is a nightly-only experimental API.
```

--------------------------------

### partition

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Consumes an iterator, creating two collections from it.

```APIDOC
## fn partition<B, F>(self, f: F) -> (B, B)
where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,
Consumes an iterator, creating two collections from it. Read more
Source
```

--------------------------------

### ECEF::as_vector_mut

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets a mutable reference to the inner `Vector3<f64>` storing the ECEF data.

```APIDOC
## `ECEF::as_vector_mut`

### Description
Get a mutable reference to the inner `Vector3` storing the data.

### Method
```rust
pub fn as_vector_mut(&mut self) -> &mut Vector3<f64>
```
```

--------------------------------

### ECEF::as_array

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets a reference to the inner array storing the ECEF data (x, y, z).

```APIDOC
## `ECEF::as_array`

### Description
Get a reference to the inner array storing the data.

### Method
```rust
pub fn as_array(&self) -> &[f64; 3]
```
```

--------------------------------

### Cloning and Ownership

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHRadians.html

Methods related to cloning and managing ownership of LLHRadians instances.

```APIDOC
## 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`.

### Parameters
- `dest`: A raw pointer to the destination memory location.

### Safety
This function is unsafe because it dereferences a raw pointer `dest`. The caller must ensure that `dest` is valid and points to enough memory to hold a `LLHRadians` instance.

### Example
```rust
let radians = LLHRadians { ... };
let mut buffer = [0u8; std::mem::size_of::<LLHRadians>()];
unsafe {
    radians.clone_to_uninit(buffer.as_mut_ptr());
}
```
```

```APIDOC
## fn from(t: T) -> T

Returns the argument unchanged. This is part of the `From<T>` trait implementation.

### Parameters
- `t`: The value to convert.

### Returns
- `T`: The same value that was passed in.

### Example
```rust
let original_radians = LLHRadians { ... };
let new_radians = LLHRadians::from(original_radians);
```
```

```APIDOC
## fn into(self) -> U

Calls `U::from(self)`. This is part of the `Into<U>` trait implementation.

### Returns
- `U`: The converted value.

### Example
```rust
let radians = LLHRadians { ... };
let some_other_type: SomeOtherType = radians.into();
```
```

```APIDOC
## type Owned = T

The type resulting from obtaining ownership. For `LLHRadians`, this is `LLHRadians` itself.

### Example
```rust
let owned_type: <LLHRadians as ToOwned>::Owned = LLHRadians { ... };
```
```

```APIDOC
## fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning.

### Returns
- `T`: An owned version of the data.

### Example
```rust
let radians = LLHRadians { ... };
let owned_radians = radians.to_owned();
```
```

```APIDOC
## fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning.

### Parameters
- `target`: A mutable reference to the owned data to be replaced.

### Example
```rust
let radians = LLHRadians { ... };
let mut owned_radians = LLHRadians { ... };
radians.clone_into(&mut owned_radians);
```
```

--------------------------------

### Clone Implementation for ConstellationIter

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.ConstellationIter.html

Allows creating a copy of the ConstellationIter.

```APIDOC
### impl Clone for ConstellationIter

#### Methods
- `fn clone(&self) -> ConstellationIter`
  Returns a duplicate of the value.
- `fn clone_from(&mut self, source: &Self)`
  Performs copy-assignment from `source`.
```

--------------------------------

### Get LLHRadians Components

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHRadians.html

Retrieves the individual latitude, longitude, or height components of the LLHRadians coordinates.

```rust
pub fn latitude(&self) -> f64
```

```rust
pub fn longitude(&self) -> f64
```

```rust
pub fn height(&self) -> f64
```

--------------------------------

### Get UtcTime Minute

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.UtcTime.html

Retrieves the minute component from a UtcTime instance. The value ranges from 0 to 59.

```rust
pub fn minute(&self) -> u8
```

--------------------------------

### try_into

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Performs the conversion. Returns a `Result` which is `Ok` on success and `Err` on failure.

```APIDOC
## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

### Description
Performs the conversion. Read more

### Method
`try_into`

### Parameters
None

### Returns
`Result<U, <U as TryFrom<T>>::Error>` - A `Result` containing the converted value or an error.
```

--------------------------------

### Get UtcTime Hour

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.UtcTime.html

Retrieves the hour component from a UtcTime instance. The value ranges from 0 to 23.

```rust
pub fn hour(&self) -> u8
```

--------------------------------

### FromStr Implementation

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/enum.ReferenceFrame.html

Allows parsing a string into a ReferenceFrame variant. Supports predefined frame names and custom frames.

```APIDOC
impl FromStr for ReferenceFrame {
    type Err = ParseError;
    fn from_str(s: &str) -> Result<ReferenceFrame, <Self as FromStr>::Err>;
}
```

--------------------------------

### ECEF::as_array_mut

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.ECEF.html

Gets a mutable reference to the inner array storing the ECEF data (x, y, z).

```APIDOC
## `ECEF::as_array_mut`

### Description
Get a mutable reference to the inner array storing the data.

### Method
```rust
pub fn as_array_mut(&mut self) -> &mut [f64; 3]
```
```

--------------------------------

### Comparison Methods

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/enum.ReferenceFrame.html

These methods allow for comparison between ReferenceFrame instances.

```APIDOC
## fn partial_cmp(&self, other: &ReferenceFrame) -> Option<Ordering>

### Description
This method returns an ordering between `self` and `other` values if one exists.

### Parameters
- **other** (&ReferenceFrame) - The other ReferenceFrame to compare against.

### Returns
- Option<Ordering> - An `Ordering` enum variant if the values are comparable, otherwise `None`.
```

```APIDOC
## fn lt(&self, other: &Rhs) -> bool

### Description
Tests less than (for `self` and `other`) and is used by the `<` operator.

### Parameters
- **other** (&Rhs) - The value to compare against.

### Returns
- bool - `true` if `self` is less than `other`, `false` otherwise.
```

```APIDOC
## fn le(&self, other: &Rhs) -> bool

### Description
Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator.

### Parameters
- **other** (&Rhs) - The value to compare against.

### Returns
- bool - `true` if `self` is less than or equal to `other`, `false` otherwise.
```

```APIDOC
## fn gt(&self, other: &Rhs) -> bool

### Description
Tests greater than (for `self` and `other`) and is used by the `>` operator.

### Parameters
- **other** (&Rhs) - The value to compare against.

### Returns
- bool - `true` if `self` is greater than `other`, `false` otherwise.
```

```APIDOC
## fn ge(&self, other: &Rhs) -> bool

### Description
Tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator.

### Parameters
- **other** (&Rhs) - The value to compare against.

### Returns
- bool - `true` if `self` is greater than or equal to `other`, `false` otherwise.
```

--------------------------------

### TransformationRepository::from_transformations

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.TransformationRepository.html

Create a repository from a list of transformations. If there are duplicated transformations in the list, the last one in the list will take priority.

```APIDOC
## TransformationRepository::from_transformations

### Description
Create a repository from a list of transformations.

### Note
If there are duplicated transformations in the list, the last one in the list will take priority.

### Method
```rust
pub fn from_transformations<T: IntoIterator<Item = Transformation>>( transformations: T, ) -> Self
```
```

--------------------------------

### Get reference to inner Vector3

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Provides a reference to the inner `Vector3` object that stores the coordinate data.

```rust
pub fn as_vector(&self) -> &Vector3<f64>
```

--------------------------------

### AzimuthElevation Comparison Implementations

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.AzimuthElevation.html

Implementations for equality and partial ordering comparisons.

```APIDOC
## AzimuthElevation Comparison Implementations

### PartialEq
```rust
impl PartialEq for AzimuthElevation
```
Tests for `self` and `other` values to be equal, and is used by `==`.

### PartialOrd
```rust
impl PartialOrd for AzimuthElevation
```
This method returns an ordering between `self` and `other` values if one exists.
```

--------------------------------

### Get UtcTime Day of Month

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.UtcTime.html

Retrieves the day of the month from a UtcTime instance. The value ranges from 1 to 31.

```rust
pub fn day_of_month(&self) -> u8
```

--------------------------------

### ReferenceFrameIter Implementations

Source: https://docs.rs/swiftnav/latest/swiftnav/reference_frame/struct.ReferenceFrameIter.html

This section details the various trait implementations for ReferenceFrameIter, providing insights into its capabilities and how it interacts with other Rust features.

```APIDOC
## impl UnwindSafe for ReferenceFrameIter

This implementation indicates that `ReferenceFrameIter` is safe to unwind across.

## Blanket Implementations

### impl<T> Any for T
where T: 'static + ?Sized,

#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T
where T: ?Sized,

#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T
where T: ?Sized,

#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> CloneToUninit for T
where T: Clone,

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)
Performs copy-assignment from `self` to `dest`.

### impl<T> From<T> for T

#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T
where U: From<T>,

#### type Item = <I as Iterator>::Item
The type of the elements being iterated over.

#### type IntoIter = I
Which kind of iterator are we turning this into?

#### fn into_iter(self) -> I
Creates an iterator from a value.

### impl<T> Same for T

#### type Output = T
Should always be `Self`

### impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

#### fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct `self` from the equivalent element of its superset.

#### fn is_in_subset(&self) -> bool
Checks if `self` is actually part of its subset `T` (and can be converted to it).

#### fn to_subset_unchecked(&self) -> SS
Use with care! Same as `self.to_subset` but without any property checks. Always succeeds.

#### fn from_subset(element: &SS) -> SP
The inclusion map: converts `self` to the equivalent element of its superset.

### impl<T> ToOwned for T
where T: Clone,

#### type Owned = T
The resulting type after obtaining ownership.

#### fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning.

#### fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning.

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

#### type Error = Infallible
The type returned in the event of a conversion error.

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

#### type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.
```

--------------------------------

### Iterator Implementation for ConstellationIter

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.ConstellationIter.html

Core iterator functionality for ConstellationIter, including getting the next item and size hints.

```rust
type Item = Constellation
```

```rust
fn next(&mut self) -> Option<<Self as Iterator>::Item>
```

```rust
fn size_hint(&self) -> (usize, Option<usize>)
```

```rust
fn nth(&mut self, n: usize) -> Option<<Self as Iterator>::Item>
```

```rust
fn next_chunk<const N: usize>( &mut self, ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>
where Self: Sized,
```

```rust
fn count(self) -> usize
where Self: Sized,
```

```rust
fn last(self) -> Option<Self::Item>
where Self: Sized,
```

```rust
fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
```

```rust
fn step_by(self, step: usize) -> StepBy<Self>
where Self: Sized,
```

```rust
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator<Item = Self::Item>,
```

```rust
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>
where Self: Sized, U: IntoIterator,
```

```rust
fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
where Self: Sized, Self::Item: Clone,
```

```rust
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
where Self: Sized, G: FnMut() -> Self::Item,
```

--------------------------------

### Borrowing

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHRadians.html

Provides methods for borrowing references to LLHRadians instances.

```APIDOC
## fn borrow(&self) -> &T

Immutably borrows from an owned value.

### Returns
- `&T`: An immutable reference to the borrowed value.

### Example
```rust
let radians = LLHRadians { ... };
let borrowed_radians: &LLHRadians = (&radians).borrow();
```
```

```APIDOC
## fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value.

### Returns
- `&mut T`: A mutable reference to the borrowed value.

### Example
```rust
let mut radians = LLHRadians { ... };
let borrowed_mut_radians: &mut LLHRadians = radians.borrow_mut();
```
```

--------------------------------

### Get UtcTime Day of Year

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.UtcTime.html

Retrieves the day of the year from a UtcTime instance. The value ranges from 1 to 366.

```rust
pub fn day_of_year(&self) -> u16
```

--------------------------------

### into

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Calls `U::from(self)`. The conversion behavior is determined by the `From<T> for U` implementation.

```APIDOC
## fn into(self) -> U

### Description
Calls `U::from(self)`. That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

### Method
`into`

### Parameters
None

### Returns
U - The converted value.
```

--------------------------------

### Get UtcTime Year

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.UtcTime.html

Retrieves the year component (CE) from a UtcTime instance. The year is returned in a four-digit format.

```rust
pub fn year(&self) -> u16
```

--------------------------------

### Get reference to inner array

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.NED.html

Provides a reference to the inner array storing the 3 f64 coordinate values.

```rust
pub fn as_array(&self) -> &[f64; 3]
```

--------------------------------

### Try Conversion

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.LLHRadians.html

Methods for attempting conversions between types, with error handling.

```APIDOC
## type Error = Infallible

The type returned in the event of a conversion error. For `TryFrom<U>` for `T`, this is `Infallible`, meaning the conversion will not fail.

### Example
```rust
let error_type: <LLHRadians as TryFrom<SomeType>>::Error = std::convert::Infallible;
```
```

```APIDOC
## fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion. This is part of the `TryFrom<U>` trait implementation.

### Parameters
- `value`: The value to attempt to convert.

### Returns
- `Result<T, <T as TryFrom<U>>::Error>`: `Ok(T)` if the conversion is successful, or an `Err` if it fails (though for `Infallible` error type, this will always be `Ok`).

### Example
```rust
let some_value: SomeType = ...;
let result: Result<LLHRadians, std::convert::Infallible> = LLHRadians::try_from(some_value);
```
```

```APIDOC
## type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error. This is part of the `TryInto<U>` trait implementation.

### Example
```rust
let error_type: <LLHRadians as TryInto<SomeType>>::Error = ...;
```
```

```APIDOC
## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion. This is part of the `TryInto<U>` trait implementation.

### Returns
- `Result<U, <U as TryFrom<T>>::Error>`: `Ok(U)` if the conversion is successful, or an `Err` if it fails.

### Example
```rust
let radians = LLHRadians { ... };
let result: Result<SomeType, SomeError> = radians.try_into();
```
```

--------------------------------

### by_ref

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.CodeIter.html

Creates a “by reference” adapter for this instance of `Iterator`.

```APIDOC
## fn by_ref(&mut self) -> &mut Self
where Self: Sized,
Creates a “by reference” adapter for this instance of `Iterator`. Read more
1.0.0 · Source
```

--------------------------------

### Get Coordinate Velocity

Source: https://docs.rs/swiftnav/latest/swiftnav/coords/struct.Coordinate.html

Retrieves an `Option<ECEF>` representing the velocity of the `Coordinate`. Returns `None` if velocity is not present.

```rust
pub fn velocity(&self) -> Option<ECEF>
```

--------------------------------

### partition

Source: https://docs.rs/swiftnav/latest/swiftnav/signal/struct.ConstellationIter.html

Consumes an iterator, creating two collections based on a predicate.

```APIDOC
## partition<B, F>(self, f: F) -> (B, B)

### Description
Consumes an iterator, creating two collections from it.

### Parameters
#### Path Parameters
- **f** (F) - Required - The closure that determines which partition an element belongs to.

### Returns
- **(B, B)** - A tuple containing two collections, partitioned based on the predicate.
```

--------------------------------

### GpsTime::to_bds

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.GpsTime.html

Converts the GpsTime object to a BdsTime object. This function will panic if the GpsTime is before the start of Beidou time.

```APIDOC
## GpsTime::to_bds

### Description
Converts the GPS time into Beidou time.

### Returns
- `BdsTime` - The converted Beidou time.

### Panics
This function will panic if the GPS time is before the start of Beidou time, i.e. `BDS_TIME_START`.
```

--------------------------------

### GpsTime::to_gal

Source: https://docs.rs/swiftnav/latest/swiftnav/time/struct.GpsTime.html

Converts the GpsTime object to a GalTime object. This function will panic if the GpsTime is before the start of Galileo time.

```APIDOC
## GpsTime::to_gal

### Description
Converts the GPS time into Galileo time.

### Returns
- `GalTime` - The converted Galileo time.

### Panics
This function will panic if the GPS time is before the start of Galileo time, i.e. `GAL_TIME_START`.
```
Tokens:
Raw