tlmcmddb

https://docs.rs/tlmcmddb/2.6.1
Admin
A Rust crate providing data structures and utilities for managing telemetry and command definitions...
Tokens:14,454
Snippets:97
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Any Trait Implementation

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Provides a method to get the TypeId of a type, applicable to any type T.

```rust
fn type_id(&self) -> TypeId
```

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

### Get Bit Width of VariableType

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.VariableType.html

Returns the size in bits for a given VariableType. This is useful for understanding data representation.

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

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

### Get Octet Width of VariableType

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.VariableType.html

Returns the size in octets (bytes) for a given VariableType. This is useful for memory allocation or data packing.

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

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

### PartialEq Implementation for Command

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Enables equality comparison between Command instances.

```rust
fn eq(&self, other: &Command) -> bool
```

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

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

### Command Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Details the various trait implementations for the Command struct, including Clone, Debug, Deserialize, PartialEq, Serialize, Eq, and others.

```APIDOC
## Trait Implementations for Command

### `impl Clone for Command`
Allows creating a duplicate of a Command instance.

### `impl Debug for Command`
Enables formatting the Command for debugging purposes.

### `impl<'de> Deserialize<'de> for Command`
Supports deserializing a Command from a Serde deserializer.

### `impl PartialEq for Command`
Provides functionality to compare two Command instances for equality.

### `impl Serialize for Command`
Supports serializing a Command into a Serde serializer.

### `impl Eq for Command`
Indicates that Command instances can be checked for equality.

### `impl StructuralPartialEq for Command`
Provides structural partial equality comparison.

### Auto Trait Implementations
- `Freeze`
- `RefUnwindSafe`
- `Send`
- `Sync`
- `Unpin`
- `UnwindSafe`

### Blanket Implementations
- `Any`
- `Borrow<T>`
- `BorrowMut<T>`
- `CloneToUninit` (Nightly-only experimental)
- `From<T>`
- `Into<U>`
- `ToOwned`
- `TryFrom<U>`
- `TryInto<U>`
- `DeserializeOwned`
```

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

### Define Command Database Structures in Rust

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/cmd.rs.html

Defines the Database, Command, Parameter, and DataType structures used for command definitions. These structures derive Serialize and Deserialize for compatibility with Serde.

```rust
1use serde::{Deserialize, Serialize};

/// あるコンポーネントのコマンド定義のデータベース
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Database {
    /// このコマンドに含まれる [Entry] のリスト
    pub entries: Vec<Entry>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE", tag = "type")]
pub enum Entry {
    /// コマンド定義行
    Command(Command),
    /// コメント行
    Comment(Comment),
}

/// コマンド定義
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Command {
    /// コマンド名
    pub name: String,
    pub target: String,
    /// コマンドのID
    pub code: u16,
    /// コマンドのパラメータのリスト。要素数は0以上6個以下
    pub parameters: Vec<Parameter>,
    pub is_danger: bool,
    pub is_restricted: bool,
    /// コマンドの説明（衛星運用者向け）
    pub description: String,
    /// コマンドの説明（衛星開発者向け）
    pub note: String,
}

/// コマンドのパラメータ定義
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Parameter {
    /// パラメータのデータ型
    pub data_type: DataType,
    /// パラメータの説明
    pub description: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum DataType {
    /// 符号あり8bit整数
    #[serde(rename = "int8_t")]
    Int8,
    /// 符号あり16bit整数
    #[serde(rename = "int16_t")]
    Int16,
    /// 符号あり32bit整数
    #[serde(rename = "int32_t")]
    Int32,
    /// 符号なし8bit整数
    #[serde(rename = "uint8_t")]
    Uint8,
    /// 符号なし16bit整数
    #[serde(rename = "uint16_t")]
    Uint16,
    /// 符号なし32bit整数
    #[serde(rename = "uint32_t")]
    Uint32,
    /// IEEE 754 単精度浮動小数
    #[serde(rename = "float")]
    Float,
    /// IEEE 754 倍精度浮動小数
    #[serde(rename = "double")]
    Double,
    /// 生データ, 可変長パラメータ
    #[serde(rename = "raw")]
    Raw,
}

/// コメント行
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Comment {
    /// コメントの内容
    pub text: String,
}
```

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

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Nightly-only experimental API for performing copy-assignment from self to a raw pointer destination.

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

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

### Clone Implementation for Command

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Provides methods for duplicating and copying Command values.

```rust
fn clone(&self) -> Command
```

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

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

### Conversion Modules (Status and Polynomial)

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Details the structures used for Status and Polynomial conversions.

```APIDOC
## Conversion Modules (Status and Polynomial)

### Description
Provides detailed structures for specific conversion types used in telemetry fields.

#### `conversion::Status` Structure

- **variants** (Vec<Variant>) - Required - A list mapping integer keys to their corresponding string values.
- **default_value** (Option<String>) - Optional - The string value to use if an integer key is not found in `variants`.

#### `conversion::Variant` Structure

- **key** (i64) - Required - The integer value to be converted.
- **value** (String) - Required - The string representation for the given key.

#### `conversion::Polynomial` Structure

- **a0** (f64) - Required - The constant term of the polynomial.
- **a1** (f64) - Required - The coefficient for the linear term (x).
- **a2** (f64) - Required - The coefficient for the quadratic term (x^2).
- **a3** (f64) - Required - The coefficient for the cubic term (x^3).
```

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

### Trait Implementations for Entry

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.Entry.html

Details on the trait implementations available for the Entry enum.

```APIDOC
### impl Clone for Entry

#### fn clone(&self) -> Entry

Returns a duplicate of the value.

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

Performs copy-assignment from `source`.

### impl Debug for Entry

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

Formats the value using the given formatter.

### impl<'de> Deserialize<'de> for Entry

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

Deserialize this value from the given Serde deserializer.

### impl PartialEq for Entry

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

Tests for `self` and `other` values to be equal, and is used by `==`.

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

Tests for `!=`.

### impl Serialize for Entry

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

Serialize this value into the given Serde serializer.

### impl StructuralPartialEq for Entry
```

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

### Serialize Implementation for Command

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Allows Command structs to be serialized into a Serde serializer.

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

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

### Implement PartialEq for SubEntry

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.SubEntry.html

Defines equality comparison for SubEntry values. Use this to check if two entries are identical.

```rust
fn eq(&self, other: &SubEntry) -> bool
```

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

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

### Define Command Struct

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Defines the structure for a command, including its name, target, code, parameters, danger/restricted flags, and descriptions.

```rust
pub struct Command {
    pub name: String,
    pub target: String,
    pub code: u16,
    pub parameters: Vec<Parameter>,
    pub is_danger: bool,
    pub is_restricted: bool,
    pub description: String,
    pub note: String,
}
```

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

### Telemetry Database Structures

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Core structs for defining telemetry databases and individual telemetry definitions.

```rust
use serde::{Deserialize, Serialize};

/// あるコンポーネントのテレメトリ定義のデータベース
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Database {
    /// データベースに含まれるテレメトリ定義のリスト
    pub telemetries: Vec<Telemetry>,
}

/// テレメトリの定義
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Telemetry {
    /// このテレメトリ定義の名前
    pub name: String,
    /// このテレメトリ定義のメタデータ
    pub metadata: Metadata,
    /// このテレメトリの構造定義
    /// blobが追加される前との互換性のため、entriesに rename する
    #[serde(rename = "entries")]
    pub content: Content,
}

/// テレメトリ定義のメタデータ
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Metadata {
    pub target: String,
    /// テレメトリ定義のID。SH.TLM_IDと一致する
    pub packet_id: u8,
    pub is_enabled: bool,
    pub is_restricted: bool,
    pub local_variables: String,
}

/// バイト列を解釈しなblob tlmと、entryのリストとして解釈されるstruct tlmがある
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
/// blob が追加される前との互換性のため、untaggedとする
#[serde(untagged)]
pub enum Content {
    /// このテレメトリはblobであり、構造をもたない
    Blob,
    /// このテレメトリ定義に含まれる [Entry] のリスト
    Struct(Vec<Entry>),
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE", tag = "type")]
pub enum Entry {
    /// ビットフィールドの集合
    FieldGroup(FieldGroup),
    /// コメント行
    Comment(Comment),
}

/// ビットフィールドの集合
///
/// TLM DB CSVにおいて縦方向のセル結合で表現されているもの。
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct FieldGroup {
    /// 搭載ソフトウェアのコード生成に必要な情報
    pub onboard_software_info: OnboardSoftwareInfo,
    /// この [`FieldGroup`] に含まれる [SubEntry] のリスト
    pub sub_entries: Vec<SubEntry>,
}

/// [FieldGroup] 内のエントリ
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE", tag = "type")]
// コメント行はそれほど多くないはずなので large_enum_variantは許容する
#[allow(clippy::large_enum_variant)]
pub enum SubEntry {
    Field(Field),
    Comment(Comment),
}

/// オクテットアラインされていないフィールド（ビットフィールド）
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Field {
    pub name: String,
    /// テレメトリのオクテット列からこのフィールドの値を抜き出す際に必要な情報
    pub extraction_info: FieldExtractionInfo,
    pub conversion_info: ConversionInfo,
    /// GS SW などでテレメトリを表示するときの情報
    #[serde(default)]
    #[serde(skip_serializing_if = "Option::is_none")] // serialize v2 compatible if None
    pub display_info: Option<DisplayInfo>,
    /// このフィールドの説明（衛星運用者向け）
    pub description: String,
    /// このフィールドの説明（衛星開発者向け）
    pub note: String,
}

/// [Field] の値をテレメトリのオクテット列から抜き出す際に必要な情報
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct FieldExtractionInfo {
    /// 未使用。通常は `"PACKET"` で固定。SIB2 由来
    pub extraction_type: String,
    /// このフィールドの値のMSBが、テレメトリのオクテット列内の `octet_position` オクテット目にあることを示す
    pub octet_position: usize,
    /// このフィールドの値のMSBが、`octet_position` オクテット目の `bit_position` ビット目（MSBを0とする）にあることを示す
    pub bit_position: usize,
    /// このフィールドの値のビット幅を示す
    pub bit_length: usize,
}

/// 搭載ソフトウェアのコード生成に必要な情報
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct OnboardSoftwareInfo {
    /// 搭載ソフトウェアにおいて [FieldGroup] の値を表現するために用いるデータ型
    ///
    /// [FieldGroup] に複数の [Field] が含まれる場合は符号なし整数型([`Uint8`](VariableType::Uint8), [`Uint16`](VariableType::Uint16), [`Uint32`](VariableType::Uint32))でなければならない。
    pub variable_type: VariableType,
    /// 搭載ソフトウェアにおいて、このフィールドの値を組み立てるための式
    pub expression: String,
}

/// 工学値変換の規則
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum ConversionInfo {
    /// 変換なし（工学値は生値と同一）
    None,
    /// 変換なし。地上局ソフトウェアで工学値を表示する際は16進数で表示する
    Hex,
    /// ステータス変換。整数値に対応する文字列を定義し、その文字列を工学値とする
    Status(conversion::Status),
    /// 多項式変換。ここで定義した係数からなる多項式において、生値を不定元とした値を工学値とする
    Polynomial(conversion::Polynomial),
}
```

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

### DisplayInfo Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.DisplayInfo.html

Details on the various trait implementations for the DisplayInfo struct.

```APIDOC
## Trait Implementations for DisplayInfo

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

### impl Debug for DisplayInfo
- `fn fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### impl Default for DisplayInfo
- `fn default() -> DisplayInfo`: Returns the “default value” for a type.

### impl<'de> Deserialize<'de> for DisplayInfo
- `fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserialize this value from the given Serde deserializer.

### impl PartialEq for DisplayInfo
- `fn eq(&self, other: &DisplayInfo) -> bool`: Tests for `self` and `other` values to be equal.
- `fn ne(&self, other: &Rhs) -> bool`: Tests for `!=`.

### impl Serialize for DisplayInfo
- `fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serialize this value into the given Serde serializer.

### impl StructuralPartialEq for DisplayInfo

### Auto Trait Implementations
- `impl Freeze for DisplayInfo`
- `impl RefUnwindSafe for DisplayInfo`
- `impl Send for DisplayInfo`
- `impl Sync for DisplayInfo`
- `impl Unpin for DisplayInfo`
- `impl UnwindSafe for DisplayInfo`

### Blanket Implementations
- `impl<T> Any for T`
  - `fn type_id(&self) -> TypeId`: Gets the `TypeId` of `self`.
- `impl<T> Borrow<T> for T`
  - `fn borrow(&self) -> &T`: Immutably borrows from an owned value.
- `impl<T> BorrowMut<T> for T`
  - `fn borrow_mut(&mut self) -> &mut T`: Mutably borrows from an owned value.
- `impl<T> CloneToUninit for T` (Nightly-only experimental API)
  - `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`
  - `fn into(self) -> U`: Calls `U::from(self)`.
- `impl<T> ToOwned for T`
  - `type Owned = T`
  - `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`
  - `type Error = Infallible`
  - `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`: Performs the conversion.
- `impl<T, U> TryInto<U> for T`
  - `type Error = <U as TryFrom<T>>::Error`
  - `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`: Performs the conversion.
- `impl<T> DeserializeOwned for T`
```

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

### Implement PartialEq for FieldGroup

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.FieldGroup.html

Provides methods for comparing two FieldGroup instances for equality. This is used by the equality operators (== and !=).

```rust
fn eq(&self, other: &FieldGroup) -> bool
```

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

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

### Command Struct Definition

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Defines the structure for a command, including its name, target, ID, parameters, security flags, and descriptions.

```APIDOC
## Struct Command

### Description
Represents a command definition.

### Fields
- **name** (String) - The name of the command.
- **target** (String) - The target for the command.
- **code** (u16) - The unique identifier (ID) for the command.
- **parameters** (Vec<Parameter>) - A list of parameters for the command. The list can contain 0 to 6 elements.
- **is_danger** (bool) - Flag indicating if the command is dangerous.
- **is_restricted** (bool) - Flag indicating if the command is restricted.
- **description** (String) - A description of the command intended for satellite operators.
- **note** (String) - A note or additional explanation for the command, intended for satellite developers.
```

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

### OnboardSoftwareInfo Structure

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.OnboardSoftwareInfo.html

Definition of the OnboardSoftwareInfo struct used for onboard software code generation.

```APIDOC
## OnboardSoftwareInfo

### Description
Represents the information required for generating code for onboard software.

### Fields
- **variable_type** (VariableType) - Required - The data type used to represent the value of a FieldGroup in the onboard software. If the FieldGroup contains multiple fields, this must be an unsigned integer type (Uint8, Uint16, Uint32).
- **expression** (String) - Required - The expression used to assemble the value of this field in the onboard software.
```

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

### Implement PartialEq for Telemetry

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Telemetry.html

Provides functionality to test for equality between two Telemetry values. Used for comparing telemetry data.

```rust
fn eq(&self, other: &Telemetry) -> bool
```

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

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

### Field Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Field.html

Details the trait implementations available for the Field struct, such as Clone, Debug, Deserialize, PartialEq, Serialize, and others.

```APIDOC
## Trait Implementations for Field

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

### `Debug`
- `fn fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### `Deserialize` (from Serde)
- `fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserializes this value from the given Serde deserializer.

### `PartialEq`
- `fn eq(&self, other: &Field) -> bool`: Tests for equality between two `Field` instances.
- `fn ne(&self, other: &Rhs) -> bool`: Tests for inequality between two `Field` instances.

### `Serialize` (from Serde)
- `fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serializes this value into the given Serde serializer.

### `StructuralPartialEq`

### Auto Trait Implementations
- `Freeze`
- `RefUnwindSafe`
- `Send`
- `Sync`
- `Unpin`
- `UnwindSafe`

### Blanket Implementations
- `Any`
- `Borrow<T>`
- `BorrowMut<T>`
- `CloneToUninit` (Nightly-only experimental)
- `From<T>`
- `Into<U>`
- `ToOwned`
- `TryFrom<U>`
- `TryInto<U>`
- `DeserializeOwned`
```

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

### DisplayInfo Struct

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.DisplayInfo.html

Information for displaying telemetry in GS SW. The specific interpretation and usage of each field depend on the GS SW.

```APIDOC
## Struct DisplayInfo

### Description
Information for displaying telemetry in GS SW. The specific interpretation and usage of each field depend on the GS SW.

### Fields
- **label** (String) - Required - Display name.
- **unit** (String) - Required - Unit of measurement.
- **format** (String) - Required - Format specifier.
```

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

### Module tlm

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/index.html

This section details the 'tlm' module within the tlmcmddb crate, outlining its sub-modules, structs, and enums.

```APIDOC
## Module tlm

### Description
This module contains definitions related to telemetry data, including structures for metadata, fields, and conversion information, as well as enums for data types and content interpretation.

### Structs
- **Comment**: Represents a comment line.
- **Database**: A database for telemetry definitions of a component.
- **DisplayInfo**: Information for displaying telemetry in GS SW, with specific interpretations dependent on GS SW.
- **Field**: Represents a field that is not octet-aligned (bit field).
- **FieldExtractionInfo**: Information required to extract a Field's value from telemetry octet sequences.
- **FieldGroup**: A collection of bit fields.
- **Metadata**: Metadata for telemetry definitions.
- **OnboardSoftwareInfo**: Information required for code generation of onboard software.
- **Telemetry**: Definition of a telemetry item.

### Enums
- **Content**: Represents how a byte sequence is interpreted. It can be a blob or a struct interpreted as a list of entries. It's untagged for backward compatibility.
- **ConversionInfo**: Rules for engineering value conversion.
- **Entry**: Represents an entry within a FieldGroup.
- **SubEntry**: Represents a sub-entry within a FieldGroup.
- **VariableType**: Data type used to represent field values in onboard software.
```

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

### Deserialize Implementation for Command

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/struct.Command.html

Allows Command structs to be deserialized from a Serde deserializer.

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

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

### Command Database Structure

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/cmd.rs.html

Defines the schema for the command database, which consists of a list of entries that can be either commands or comments.

```APIDOC
## Database Structure

### Description
The root object representing a component's command definition database.

### Request Body
- **entries** (Array<Entry>) - Required - A list of command or comment entries.

### Entry Object
- **type** (String) - Required - The type of entry: "COMMAND" or "COMMENT".

### Command Object
- **name** (String) - Required - Command name.
- **target** (String) - Required - Target component.
- **code** (u16) - Required - Command ID.
- **parameters** (Array<Parameter>) - Required - List of parameters (0-6 elements).
- **is_danger** (Boolean) - Required - Danger flag.
- **is_restricted** (Boolean) - Required - Restriction flag.
- **description** (String) - Required - Description for operators.
- **note** (String) - Required - Description for developers.

### Parameter Object
- **data_type** (String) - Required - Data type (int8_t, int16_t, int32_t, uint8_t, uint16_t, uint32_t, float, double, raw).
- **description** (String) - Required - Parameter description.
```

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

### Status Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Status.html

Details the various trait implementations for the Status struct, including Clone, Debug, Deserialize, PartialEq, Serialize, Eq, and others.

```APIDOC
## Trait Implementations for Status

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

### impl Debug for Status
- `fn fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### impl<'de> Deserialize<'de> for Status
- `fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserialize this value from the given Serde deserializer.

### impl PartialEq for Status
- `fn eq(&self, other: &Status) -> bool`: Tests for `self` and `other` values to be equal.
- `fn ne(&self, other: &Rhs) -> bool`: Tests for `!=`.

### impl Serialize for Status
- `fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serialize this value into the given Serde serializer.

### impl Eq for Status

### impl StructuralPartialEq for Status

### Auto Trait Implementations
- `Freeze`
- `RefUnwindSafe`
- `Send`
- `Sync`
- `Unpin`
- `UnwindSafe`

### Blanket Implementations
- `impl<T> Any for T`
  - `fn type_id(&self) -> TypeId`: Gets the `TypeId` of `self`.
- `impl<T> Borrow<T> for T`
  - `fn borrow(&self) -> &T`: Immutably borrows from an owned value.
- `impl<T> BorrowMut<T> for T`
  - `fn borrow_mut(&mut self) -> &mut T`: Mutably borrows from an owned value.
- `impl<T> CloneToUninit for T` (Nightly-only experimental API)
  - `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>`
  - `fn into(self) -> U`: Calls `U::from(self)`.
- `impl<T> ToOwned for T`
  - `type Owned = T`
  - `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`
  - `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`
  - `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`: Performs the conversion.
- `impl<T> DeserializeOwned for T` where `T: for<'de> Deserialize<'de>`
```

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

### Implement Clone for SubEntry

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.SubEntry.html

Provides functionality to create a duplicate of a SubEntry value. This is useful for scenarios where you need to copy entries without affecting the original.

```rust
fn clone(&self) -> SubEntry
```

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

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

### Implement Clone for Telemetry

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Telemetry.html

Provides functionality to create a duplicate of a Telemetry value. This is useful for making copies of telemetry data.

```rust
fn clone(&self) -> Telemetry
```

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

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

### DataType Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/cmd/enum.DataType.html

Details the trait implementations for the DataType enum, including Clone, Debug, Deserialize, Hash, PartialEq, Serialize, Copy, Eq, StructuralPartialEq, and blanket implementations.

```APIDOC
## Trait Implementations for DataType

### `impl Clone for DataType`
*   `fn clone(&self) -> DataType`: Returns a duplicate of the value.
*   `fn clone_from(&mut self, source: &Self)`: Performs copy-assignment from `source`.

### `impl Debug for DataType`
*   `fn fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### `impl<'de> Deserialize<'de> for DataType`
*   `fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserialize this value from the given Serde deserializer.

### `impl Hash for DataType`
*   `fn hash<__H: Hasher>(&self, state: &mut __H)`: Feeds this value into the given `Hasher`.
*   `fn hash_slice<H>(data: &[Self], state: &mut H)`: Feeds a slice of this type into the given `Hasher`.

### `impl PartialEq for DataType`
*   `fn eq(&self, other: &DataType) -> bool`: Tests for `self` and `other` values to be equal.
*   `fn ne(&self, other: &Rhs) -> bool`: Tests for `!=`.

### `impl Serialize for DataType`
*   `fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serialize this value into the given Serde serializer.

### `impl Copy for DataType`

### `impl Eq for DataType`

### `impl StructuralPartialEq for DataType`

### Blanket Implementations
*   `impl<T> Any for T`
*   `impl<T> Borrow<T> for T`
*   `impl<T> BorrowMut<T> for T`
*   `impl<T> CloneToUninit for T`
*   `impl<T> From<T> for T`
*   `impl<T, U> Into<U> for T`
*   `impl<T> ToOwned for T`
*   `impl<T, U> TryFrom<U> for T`
*   `impl<T, U> TryInto<U> for T`
*   `impl<T> DeserializeOwned for T`
```

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

### Telemetry Trait Implementations

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Telemetry.html

Lists the available trait implementations for the Telemetry struct, such as Clone, Debug, Deserialize, PartialEq, and Serialize.

```APIDOC
## Trait Implementations for Telemetry

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

### Debug
- `fmt(&self, f: &mut Formatter<'_>) -> Result`: Formats the value using the given formatter.

### Deserialize<'de>
- `deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>`: Deserialize this value from the given Serde deserializer.

### PartialEq
- `eq(&self, other: &Telemetry) -> bool`: Tests for `self` and `other` values to be equal.
- `ne(&self, other: &Rhs) -> bool`: Tests for `!=`.

### Serialize
- `serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>`: Serialize this value into the given Serde serializer.

### StructuralPartialEq
```

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

### Database and Telemetry Structures

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Defines the main structures for the telemetry database, including the list of telemetries and individual telemetry definitions.

```APIDOC
## Database and Telemetry Structures

### Description
Defines the root `Database` structure which contains a list of `Telemetry` objects. Each `Telemetry` object includes its name, associated metadata, and its content structure.

### Structures

#### `Database`

- **telemetries** (Vec<Telemetry>) - Required - A list of telemetry definitions contained within the database.

#### `Telemetry`

- **name** (String) - Required - The name of this telemetry definition.
- **metadata** (Metadata) - Required - Metadata associated with this telemetry definition.
- **content** (Content) - Required - The structure definition of this telemetry, aliased as `entries` for backward compatibility.

### Request Example
```json
{
  "telemetries": [
    {
      "name": "ExampleTelemetry",
      "metadata": {
        "target": "ExampleTarget",
        "packet_id": 1,
        "is_enabled": true,
        "is_restricted": false,
        "local_variables": ""
      },
      "entries": {
        "type": "Struct",
        "fields": [
          {
            "type": "FieldGroup",
            "onboard_software_info": {
              "variable_type": "Uint16",
              "expression": "value"
            },
            "sub_entries": [
              {
                "type": "Field",
                "name": "ExampleField",
                "extraction_info": {
                  "extraction_type": "PACKET",
                  "octet_position": 0,
                  "bit_position": 0,
                  "bit_length": 16
                },
                "conversion_info": {
                  "type": "None"
                },
                "display_info": null,
                "description": "An example field.",
                "note": "Example note."
              }
            ]
          }
        ]
      }
    }
  ]
}
```

### Response Example
```json
{
  "telemetries": [
    {
      "name": "ExampleTelemetry",
      "metadata": {
        "target": "ExampleTarget",
        "packet_id": 1,
        "is_enabled": true,
        "is_restricted": false,
        "local_variables": ""
      },
      "entries": {
        "type": "Struct",
        "fields": [
          {
            "type": "FieldGroup",
            "onboard_software_info": {
              "variable_type": "Uint16",
              "expression": "value"
            },
            "sub_entries": [
              {
                "type": "Field",
                "name": "ExampleField",
                "extraction_info": {
                  "extraction_type": "PACKET",
                  "octet_position": 0,
                  "bit_position": 0,
                  "bit_length": 16
                },
                "conversion_info": {
                  "type": "None"
                },
                "display_info": null,
                "description": "An example field.",
                "note": "Example note."
              }
            ]
          }
        ]
      }
    }
  ]
}
```
```

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

### Implement Clone for FieldGroup

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.FieldGroup.html

Provides methods to create a duplicate of a FieldGroup instance or copy data from one instance to another. This is useful for managing data copies.

```rust
fn clone(&self) -> FieldGroup
```

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

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

### PartialEq Implementation for Variant

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Defines equality comparison for Variant structs, used by the == and != operators.

```rust
fn eq(&self, other: &Variant) -> bool
```

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

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

### Database Structure

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Database.html

The Database struct holds a collection of telemetry definitions.

```APIDOC
## Database Structure

### Description
The Database struct is the primary container for telemetry definitions associated with a component.

### Fields
- **telemetries** (Vec<Telemetry>) - A list of telemetry definitions contained within the database.

### Serialization
This struct implements `Serialize` and `Deserialize` traits, allowing it to be easily converted to and from formats like JSON.
```

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

### Serialize Implementation for Variant

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Enables serialization of the Variant struct into a Serde serializer.

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

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

### Define Display Information Struct in Rust

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Defines a `DisplayInfo` struct to hold metadata for displaying telemetry data, including a label, unit, and format string. This struct is used for configuring how data is presented to users.

```rust
pub struct DisplayInfo {
    /// 表示名
    pub label: String,
    /// 単位
    pub unit: String,
    /// フォーマットの指定
    pub format: String,
}
```

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

### Clone Implementation for Variant

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Provides methods to create a duplicate of a Variant or copy-assign from another Variant.

```rust
fn clone(&self) -> Variant
```

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

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

### Define Telemetry Struct

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Telemetry.html

Defines the structure for telemetry data, including its name, metadata, and content. Used for representing telemetry definitions.

```rust
pub struct Telemetry {
    pub name: String,
    pub metadata: Metadata,
    pub content: Content,
}
```

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

### Define Comment struct

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Comment.html

The primary structure used to store comment text.

```rust
pub struct Comment {
    pub text: String,
}
```

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

### Entry and SubEntry Structures

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Defines the types of entries that can exist within a telemetry's content structure, including field groups and comments.

```APIDOC
## Entry and SubEntry Structures

### Description
Defines the possible elements within a telemetry's structure. Entries can be `FieldGroup`s or `Comment`s. SubEntries within a `FieldGroup` can be `Field`s or `Comment`s.

### Types

#### `Entry` Enum

- **FieldGroup(FieldGroup)** - Represents a group of related fields.
- **Comment(Comment)** - Represents a comment line within the telemetry definition.

#### `SubEntry` Enum

- **Field(Field)** - Represents an individual field within a `FieldGroup`.
- **Comment(Comment)** - Represents a comment line within a `FieldGroup`.
```

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

### ConversionInfo Enum

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Defines the rules for converting a raw field value to an engineering unit.

```APIDOC
## ConversionInfo Enum

### Description
Specifies the conversion rules to transform a raw field value into an engineering unit. Supported conversions include no conversion, hexadecimal display, status mapping, and polynomial conversion.

### Variants

- **None** - No conversion is applied; the engineering value is the same as the raw value.
- **Hex** - No conversion is applied, but the raw value should be displayed in hexadecimal format by ground station software.
- **Status(conversion::Status)** - Converts the integer value to a string representation based on predefined variants and a default value.
- **Polynomial(conversion::Polynomial)** - Converts the raw value using a polynomial function defined by coefficients `a0`, `a1`, `a2`, and `a3`.
```

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

### Metadata Structure

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Defines the metadata associated with each telemetry definition.

```APIDOC
## Metadata Structure

### Description
Contains metadata for a telemetry definition, including target system, packet ID, and enablement status.

### Fields

- **target** (String) - Required - The target system for this telemetry.
- **packet_id** (u8) - Required - The ID of the telemetry packet, matching `SH.TLM_ID`.
- **is_enabled** (bool) - Required - Indicates if the telemetry is currently enabled.
- **is_restricted** (bool) - Required - Indicates if the telemetry is restricted.
- **local_variables** (String) - Required - Local variables associated with the telemetry.
```

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

### Telemetry Conversion Logic

Source: https://docs.rs/tlmcmddb/2.6.1/src/tlmcmddb/tlm.rs.html

Structures for defining engineering value conversion rules, including status mapping and polynomial coefficients.

```rust
pub mod conversion {
    use serde::{Deserialize, Serialize};

    /// ステータス変換の規則の定義
    #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
    pub struct Status {
        /// 整数値と文字列の対応のリスト
        pub variants: Vec<Variant>,
        /// `variants` で定義されていない整数値に対応する文字列
        pub default_value: Option<String>,
    }

    /// ステータス変換に用いる整数値と文字列の対応
    #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
    pub struct Variant {
        /// 変換前の整数値
        pub key: i64,
        /// 変換後の文字列
        pub value: String,
    }

    /// 多項式変換に用いる係数
    #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
    pub struct Polynomial {
        pub a0: f64,
        pub a1: f64,
        pub a2: f64,
        pub a3: f64,
    }
```

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

### Debug Implementation for Variant

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/conversion/struct.Variant.html

Allows the Variant struct to be formatted for debugging purposes.

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

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

### Field Struct

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/struct.Field.html

Represents a field within telemetry data, including its name, extraction, conversion, display, and descriptive information.

```APIDOC
## Struct Field

### Description
Represents a field within telemetry data, including its name, extraction, conversion, display, and descriptive information.

### Fields
- **name** (String) - The name of the field.
- **extraction_info** (FieldExtractionInfo) - Information required to extract the field's value from telemetry octets.
- **conversion_info** (ConversionInfo) - Information related to data conversion for the field.
- **display_info** (Option[DisplayInfo]) - Information for displaying the telemetry field, such as in GS SW.
- **description** (String) - Description of the field for satellite operators.
- **note** (String) - Description of the field for satellite developers.

### Example Usage (Conceptual)
```rust
struct Field {
    name: String,
    extraction_info: FieldExtractionInfo,
    conversion_info: ConversionInfo,
    display_info: Option<DisplayInfo>,
    description: String,
    note: String,
}
```
```

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

### Define the Entry enum

Source: https://docs.rs/tlmcmddb/2.6.1/tlmcmddb/tlm/enum.Entry.html

The Entry enum structure containing variants for field groups and comments.

```rust
pub enum Entry {
    FieldGroup(FieldGroup),
    Comment(Comment),
}
```
Tokens:
Raw