# SwiftRsync **Repository Path**: codelint/SwiftRsync ## Basic Information - **Project Name**: SwiftRsync - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-11-20 - **Last Updated**: 2026-11-21 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # SwiftRsync 一个用 Swift 实现的 rsync,锁定 **rsync 协议 29**,可与官方 rsync 3.x(`--protocol=29`)、macOS 自带 openrsync 双向互通。 - **库**:`SwiftRsync`,可作为 Swift Package 依赖直接引用。 - **命令行**:`rsync-swift`,用法对齐 rsync 常用操作。 - **零第三方依赖**:压缩算法 `-z` 也是包内的纯 Swift 实现(内部 target `SwiftDeflate`,不对外发布)。 ## 快速开始 ```bash cd SwiftRsync swift build # 产物:.build/debug/rsync-swift swift build -c release ``` 本地同步: ```bash .build/debug/rsync-swift -av --delete --exclude='*.log' ./src/ ./dst/ ``` 通过 ssh 与远端官方 rsync 同步(远端需要安装 rsync): ```bash # 推送 .build/debug/rsync-swift -avz -e ssh --rsync-path rsync ./src/ host:~/dst/ # 拉取 .build/debug/rsync-swift -avz -e ssh --rsync-path rsync host:~/src/ ./dst/ ``` > 默认 `--rsync-path` 是 `rsync-swift`;远端只有官方 rsync 时请显式指定 `--rsync-path rsync`。 让官方 rsync 使用 SwiftRsync 作为远端服务端: ```bash rsync -avz --protocol=29 -e ssh --rsync-path /path/to/rsync-swift ./src/ host:~/dst/ ``` ## 特性 | 分类 | 支持情况 | | --- | --- | | 传输形态 | 本地↔本地、客户端推送/拉取、作为远端服务端被推送/被拉取 | | 基础选项 | `-a -r -l -p -t -g -o -D -H -c -n -u -I -v -q -W --no-whole-file` | | 删除 | `--delete`、`--delete-excluded`、`--max-delete` | | 过滤 | `--exclude`、`--include`、`--filter`、`--exclude-from`、`--include-from`(`+`/`-`、通配、`**`) | | 增量传输 | 滚动校验和分块匹配、块签名、整文件 MD4 校验(含协议 29 的 seed 语义) | | 压缩 | `-z`(纯 Swift deflate/inflate,兼容 rsync 压缩令牌流) | | 元数据 | 权限、mtime、属主/属组、符号链接、硬链接、设备/特殊文件;xattr 仅本地有效 | | 远端传输 | `-e ssh`(默认)、自定义 rsh、远端路径转义、`~/` 展开 | ### 暂不支持 - rsync daemon 模式:`rsync://`、`--daemon`、`--port` - 协议 30/31 的增量递归 - `--acls`(协议 29 不支持),远端 `--xattrs`(协议 29 不支持) - 部分选项目前仅解析、不生效(如 `-i`、`-R`、`-P`、`-K`、`--list-only` 等,详见 [Docs/usage.md](Docs/usage.md)) ## 作为库引用 ```swift // Package.swift .package(path: "../SwiftRsync") // target dependencies: .product(name: "SwiftRsync", package: "SwiftRsync") ``` ```swift import SwiftRsync var options = Options.archive() // -a options.verbose = 1 options.deleteMode = true options.operands = ["/data/src/", "host:/data/dst/"] options.rsh = "ssh" options.rsyncPath = "rsync" // 远端使用官方 rsync do { let code = try Session.runClient(options) exit(code) } catch let error as RsyncError { FileHandle.standardError.write(Data("\(error.message)\n".utf8)) exit(error.code.rawValue) } ``` 更多用法见 [Docs/library.md](Docs/library.md)。 ## 目录结构 ``` Package.swift Sources/ SwiftDeflate/ 纯 Swift raw DEFLATE(内部 target) SwiftRsync/ 库:协议、引擎、过滤器、选项、传输 rsync-swift/ CLI 入口 Docs/ 使用、库、架构、协议与开发文档 ``` ## 文档 - [用法与选项](Docs/usage.md) - [作为库使用](Docs/library.md) - [架构与代码结构](Docs/architecture.md) - [协议 29 实现说明](Docs/protocol-29.md) - [开发与验证](Docs/development.md) ## 验证情况 与 rsync 3.2.7(源码构建)和 macOS 自带 openrsync 对拍: - 四种方向(客户端推/拉、服务端被推/被拉)在压缩与非压缩下均通过 - 新鲜传输、增量传输、`-B 100000` 大块令牌(>64KB 历史插入怪癖)均通过 - 功能矩阵 36 项(删除、过滤、符号链接、权限、mtime、硬链接、二次运行跳过)全部通过 - 真实 ssh(Linux 远端 rsync 3.2.7):`-avz` 6.34MB 文件线上 2.96MB,双向 sha256 一致 ## 已知取舍 - deflate 目前使用固定 Huffman 块(合法且对文本有效),不可压缩数据约有 6% 膨胀;后续可加 stored 块选择或动态 Huffman。 - `--compress-level` 目前只影响匹配链长度,未做多档精调。 - 本仓库尚未声明开源许可证;实现基于 rsync 的协议行为独立编写,未复制其源码,发布前需补充 LICENSE 并确认与 rsync(GPL)的关系。