Merge pull request #29 from Tahinli/dev

build: 👷 updated to versatile build script

.github/workflows/dev.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build
       run: cargo build --release --verbose
     - name: Run tests

.github/workflows/pr_main.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build
       run: cargo build --release --verbose
     - name: Run tests
@@ -25,7 +25,7 @@ jobs:
     runs-on: windows-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build
       run: cargo build --release --verbose
     - name: Run tests
@@ -37,7 +37,7 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Build
       run: cargo build --release --verbose
     - name: Run tests

.github/workflows/rust.yml

@@ -2,62 +2,60 @@ name: Rust -> Build & Test & Release
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 env:
   CARGO_TERM_COLOR: always
+  PROJECT_NAME: ${{ github.event.repository.name }}
 
 jobs:
   build_linux:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build
         run: cargo build --release --verbose
       - name: Run tests
         run: cargo test --verbose
 
       - name: Upload Linux Binary
-      uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-         name: rust_tcp_file_transfer_linux_x64_86
+          name: ${{ env.PROJECT_NAME }}-linux-x64_86
-         path: target/release/*transfer
+          path: target/release/${{ env.PROJECT_NAME }}
 
   build_windows:
-
     runs-on: windows-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build
         run: cargo build --release --verbose
       - name: Run tests
         run: cargo test --verbose
 
       - name: Upload Windows Binary
-      uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-         name: rust_tcp_file_transfer_windows_x64_86
+          name: ${{ env.PROJECT_NAME }}-windows-x64_86
-         path: target/release/*transfer.exe
+          path: target/release/${{ env.PROJECT_NAME }}.exe
 
   build_macos:
-
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build
         run: cargo build --release --verbose
       - name: Run tests
         run: cargo test --verbose
 
       - name: Upload MacOS Binary
-      uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-         name: rust_tcp_file_transfer_macos_x64_86
+          name: ${{ env.PROJECT_NAME }}-macos-arm64
-         path: target/release/*transfer
+          path: target/release/${{ env.PROJECT_NAME }}
 
   release:
     needs: [build_linux, build_windows, build_macos]
@@ -65,36 +63,34 @@ jobs:
     permissions:
       contents: write
     steps:
-
+      - uses: actions/checkout@v4
-        - uses: actions/checkout@v3
       - name: Forge a Folder
         run: mkdir Downloads
-          working-directory: /home/runner/work/rust-tcp-file-transfer/rust-tcp-file-transfer/
+        working-directory: /home/runner/work/${{ env.PROJECT_NAME }}/${{ env.PROJECT_NAME }}/
 
-        - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         name: Download
         with:
           path: Downloads/
 
       - name: Rename Binaries
         run: |
-                  mv Downloads/rust_tcp_file_transfer_linux_x64_86/rust-tcp-file-transfer Downloads/rust_tcp_file_transfer_linux_x64_86/rust-tcp-file-transfer-linux_x64_86
+          tree Downloads/
-                  mv Downloads/rust_tcp_file_transfer_windows_x64_86/rust-tcp-file-transfer.exe Downloads/rust_tcp_file_transfer_windows_x64_86/rust-tcp-file-transfer-windows_x64_86.exe
+          mv Downloads/${{ env.PROJECT_NAME }}-linux-x64_86/${{ env.PROJECT_NAME }} Downloads/${{ env.PROJECT_NAME }}-linux-x64_86/${{ env.PROJECT_NAME }}-linux-x64_86
-                  mv Downloads/rust_tcp_file_transfer_macos_x64_86/rust-tcp-file-transfer Downloads/rust_tcp_file_transfer_macos_x64_86/rust-tcp-file-transfer-macos_x64_86
+          mv Downloads/${{ env.PROJECT_NAME }}-windows-x64_86/${{ env.PROJECT_NAME }}.exe Downloads/${{ env.PROJECT_NAME }}-windows-x64_86/${{ env.PROJECT_NAME }}-windows-x64_86.exe
-
+          mv Downloads/${{ env.PROJECT_NAME }}-macos-arm64/${{ env.PROJECT_NAME }} Downloads/${{ env.PROJECT_NAME }}-macos-arm64/${{ env.PROJECT_NAME }}-macos-arm64
       - name: Git Commit SHA
         id: vars
         run: |
           calculatedSha=$(git rev-parse --short ${{ github.sha }})
           echo "short_sha=$calculatedSha" >> $GITHUB_OUTPUT
 
-        - uses: softprops/action-gh-release@v0.1.15
+      - uses: softprops/action-gh-release@v2
         name: Release
         with:
           tag_name: ${{ steps.vars.outputs.short_sha }}
           generate_release_notes: true
           files: |
-                      Downloads/*linux*/*transfer*
+            Downloads/*linux*/${{ env.PROJECT_NAME }}*
-                      Downloads/*windows*/*transfer*
+            Downloads/*windows*/${{ env.PROJECT_NAME }}*
-                      Downloads/*macos*/*transfer*
+            Downloads/*macos*/${{ env.PROJECT_NAME }}*
-          

.gitignore

@@ -2,6 +2,7 @@
 # will have compiled files and executables
 debug/
 target/
+.vscode/
 
 # Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
 # More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html

Cargo.toml

@@ -8,6 +8,10 @@ strip = "symbols"
 opt-level = 3
 overflow-checks = true
 lto = true
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+codegen-units = 1
+panic = "abort"
+
+[lints.rust]
+unsafe_code = "forbid"
 
 [dependencies]

README.md

@@ -2,16 +2,25 @@
 # rust-tcp-file-transfer
 TCP File Transfer Server and Client in Rust
 
+**Usage**
+> ./rust-tcp-file-transfer -h
+>
+<img src=assets/help_menu.png>
+
+
+**Examples**
+> ./rust-tcp-file-transfer -sv -s -l ~/Desktop/cat.png
+>
+> ./rust-tcp-file-transfer -cl -r -l ~/Documents/
+
+<img src=assets/example.png>
+
+**TO-DO List**
+
+☑ Standard library only.
+
 ☑ File transfer over network.
 
 ☑ Remove memory limitations. [d42412c](https://github.com/Tahinli/rust-tcp-file-transfer/pull/1/commits/d42412c57d7d95672ba64b3e489b95f1c4b04a08)
 
 ☑ Bidirectional transfer. [b0531de](https://github.com/Tahinli/rust-tcp-file-transfer/commit/b0531deb257332f46fc76de16d3a17fb3b28acee)
-
-☐ Folder transfer.
-
-☐ Remember where it stopped.
-
-☐ Reach over NAT (peer to peer).
-
-☐ Async.