# 機能設計書 64-バイナリ処理

## 概要

本ドキュメントは、Nushellにおけるバイナリデータ操作機能（bytes コマンド群）の設計を記述する。バイナリデータの切り出し、結合、分割、置換など、低レベルのバイト操作を提供する。

### 本機能の処理概要

バイナリ処理機能は、バイナリデータに対して様々な操作を行うためのサブコマンド群を提供する。ファイルのバイナリ処理、プロトコルデータの解析、バイナリフォーマットの操作などに使用できる。

**業務上の目的・背景**：バイナリファイルの操作、ネットワークプロトコルの処理、バイナリフォーマットの解析など、低レベルのデータ操作が必要な場面がある。本機能により、外部ツールに頼らずNushell内でバイナリデータを効率的に処理できる。

**機能の利用シーン**：
- バイナリファイルの一部抽出・編集
- ネットワークパケットの解析
- バイナリフォーマットのパース
- ファイルヘッダの検証
- バイナリデータの結合・分割

**主要な処理内容**：
1. `bytes at` - 指定範囲のバイトを抽出
2. `bytes add` - バイトを先頭または末尾に追加
3. `bytes build` - 複数のバイナリを結合して構築
4. `bytes collect` - リストのバイナリを結合
5. `bytes length` - バイト長を取得
6. `bytes remove` - 指定パターンを削除
7. `bytes replace` - 指定パターンを置換
8. `bytes reverse` - バイト順を逆転
9. `bytes split` - 指定パターンで分割

**関連システム・外部連携**：外部システムとの直接連携はない。

**権限による制御**：特別な権限制御はなく、すべてのユーザーが実行可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 5 | バイナリビュー | 主機能 | バイナリデータの hex dump 形式表示 |

## 機能種別

データ変換 / バイナリ操作

## 入力仕様

### 入力パラメータ

#### bytes at

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| range | Range | Yes | 抽出するバイト範囲 | 整数範囲のみ |
| rest | CellPath | No | 対象セルパス | 有効なセルパス |

#### bytes add

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| data | Binary | Yes | 追加するバイト | - |
| --end, -e | Switch | No | 末尾に追加 | - |

#### bytes build

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| rest | Any | Yes | 結合するバイナリ（可変長） | Binary型 |

#### bytes replace

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| pattern | Binary | Yes | 検索パターン | - |
| replacement | Binary | Yes | 置換値 | - |
| --all, -a | Switch | No | 全置換 | - |

#### bytes split

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| pattern | Binary | Yes | 分割パターン | - |

### 入力データソース

- **パイプライン入力**: Binary, ByteStream, Table, Record
- **ByteStream**: ストリーミング処理対応（一部コマンド）

## 出力仕様

### 出力データ

| コマンド | 出力型 | 説明 |
|---------|--------|------|
| bytes at | Binary | 抽出されたバイト |
| bytes add | Binary | バイト追加後のデータ |
| bytes build | Binary | 結合されたバイナリ |
| bytes collect | Binary | 結合されたバイナリ |
| bytes length | Int | バイト長 |
| bytes remove | Binary | パターン削除後のデータ |
| bytes replace | Binary | 置換後のデータ |
| bytes reverse | Binary | 逆順のバイナリ |
| bytes split | List[Binary] | 分割されたバイナリのリスト |

### 出力先

パイプラインへの出力（PipelineData）。

## 処理フロー

### 処理シーケンス

```
1. コマンドの引数解析
   └─ 範囲、パターン、フラグを取得

2. 入力データの判定
   └─ ByteStream の場合は特別処理
   └─ Binary の場合は直接処理
   └─ Table/Record の場合は operate() でセルパス処理

3. バイト操作の実行
   └─ 各コマンド固有の処理

4. 結果の返却
   └─ PipelineData として出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{入力の種類}
    B -->|ByteStream| C[ストリーム処理]
    B -->|Binary| D[直接処理]
    B -->|Table/Record| E[operate でセルパス処理]
    C --> F[コマンド固有処理]
    D --> F
    E --> F
    F --> G{処理種別}
    G -->|at| H[範囲抽出]
    G -->|add| I[バイト追加]
    G -->|replace| J[パターン置換]
    G -->|split| K[パターン分割]
    H --> L[Value::binary]
    I --> L
    J --> L
    K --> M[Value::list]
    L --> N[PipelineData返却]
    M --> N
    N --> O[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 範囲指定 | bytes at の範囲は両端を含む | bytes at |
| BR-002 | 負のインデックス | 負の値は末尾からのオフセット | bytes at |
| BR-003 | デフォルト追加位置 | bytes add はデフォルトで先頭に追加 | --end 省略時 |
| BR-004 | 全置換 | bytes replace はデフォルトで最初の1箇所のみ | --all 省略時 |
| BR-005 | 空パターン | 空のパターンでの split は全バイトを分割 | bytes split |

### 計算ロジック

- **bytes at**: `IntRange::absolute_bounds()` で絶対位置を計算し、スライスを返す
- **bytes add**: Vecの先頭または末尾に extend でバイトを追加
- **bytes replace**: パターンマッチングと置換を実行
- **bytes split**: パターンで区切り、Vec<Vec<u8>> を返す

## データベース操作仕様

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| UnsupportedInput | 型エラー | float範囲を bytes at に指定 | 整数範囲を使用 |
| OnlySupportsThisInputType | 型エラー | Binary以外の入力 | Binary を入力 |
| IoError | IOエラー | ByteStream読み取りエラー | 入力ストリームを確認 |

### リトライ仕様

リトライは不要。

## トランザクション仕様

本機能はトランザクション管理を行わない。

## パフォーマンス要件

- バイト操作は高速（メモリ内操作）
- ByteStreamのストリーミング処理で大容量データも処理可能
- bytes at によるスライス操作はメタデータのcontent_typeをクリア

## セキュリティ考慮事項

- バイナリデータの操作は慎重に行うこと
- 不正なバイナリデータの実行を避けるため、出力の取り扱いに注意

## 備考

- bytes at で抽出したデータは元のcontent_type（例: image/png）を失う

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: モジュール構成を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | mod.rs | `crates/nu-command/src/bytes/mod.rs` | 公開されるコマンド一覧 |

**読解のコツ**: 13のサブコマンドがエクスポートされている。

#### Step 2: 親コマンドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | bytes_.rs | `crates/nu-command/src/bytes/bytes_.rs` | bytes コマンド本体 |

**主要処理フロー**:
- **31-33行目**: ヘルプ表示のみ（サブコマンドが必要）

#### Step 3: 主要コマンドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | at.rs | `crates/nu-command/src/bytes/at.rs` | bytes at 実装 |
| 3-2 | replace.rs | `crates/nu-command/src/bytes/replace.rs` | bytes replace 実装 |
| 3-3 | split.rs | `crates/nu-command/src/bytes/split.rs` | bytes split 実装 |

**主要処理フロー（at.rs）**:
- **55-96行目**: `run()` メソッド
- **62-72行目**: Range のパース（IntRangeのみ許可）
- **77-81行目**: ByteStream の場合は stream.slice() を使用
- **145-189行目**: `map_value()` で実際のスライス処理
- **169-174行目**: Bound の種類に応じたスライス

### プログラム呼び出し階層図

```
bytes (bytes_.rs)
    │
    ├─ bytes at (at.rs)
    │      └─ run() → map_value()
    │             └─ range.absolute_bounds()
    │             └─ val[start..end]
    │
    ├─ bytes add (add.rs)
    │      └─ run() → add_impl()
    │
    ├─ bytes build (build_.rs)
    │      └─ run() → バイナリ結合
    │
    ├─ bytes collect (collect.rs)
    │      └─ run() → リストからバイナリ結合
    │
    ├─ bytes replace (replace.rs)
    │      └─ run() → replace()
    │
    ├─ bytes split (split.rs)
    │      └─ run() → split()
    │
    └─ ...その他のサブコマンド
```

### データフロー図

```
[入力]                     [処理]                              [出力]

Binary ────────────▶ コマンド固有処理 ─────────────▶ Binary/List
                           │
ByteStream ────────▶ ストリーム処理 ───────────────▶ ByteStream
                           │
Table/Record ──────▶ operate() ────────────────────▶ Table/Record
                           │
                           ▼
                    PipelineData返却
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| mod.rs | `crates/nu-command/src/bytes/mod.rs` | ソース | モジュール定義 |
| bytes_.rs | `crates/nu-command/src/bytes/bytes_.rs` | ソース | 親コマンド |
| at.rs | `crates/nu-command/src/bytes/at.rs` | ソース | bytes at 実装 |
| add.rs | `crates/nu-command/src/bytes/add.rs` | ソース | bytes add 実装 |
| build_.rs | `crates/nu-command/src/bytes/build_.rs` | ソース | bytes build 実装 |
| collect.rs | `crates/nu-command/src/bytes/collect.rs` | ソース | bytes collect 実装 |
| length.rs | `crates/nu-command/src/bytes/length.rs` | ソース | bytes length 実装 |
| remove.rs | `crates/nu-command/src/bytes/remove.rs` | ソース | bytes remove 実装 |
| replace.rs | `crates/nu-command/src/bytes/replace.rs` | ソース | bytes replace 実装 |
| reverse.rs | `crates/nu-command/src/bytes/reverse.rs` | ソース | bytes reverse 実装 |
| split.rs | `crates/nu-command/src/bytes/split.rs` | ソース | bytes split 実装 |
