Filesystem

getFiles()

• getFiles(path: string): FileInfo[]
  • Description: Lists all files and directories in the specified path.
  • Parameters:
    • path (string): The directory to list.
  • Returns:
    • An array of FileInfo objects:
      • name (string): File name.
      • path (string): Full file path.
      • isDirectory (boolean): Whether it is a directory.
      • size (number): File size (in bytes).
  • Examples:

C++

#include <iostream>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  auto files = FileUtils::GetFiles("/home/user/Documents");

  for (const auto& file : files) {
    std::cout << file.name << " - " 
              << (file.isDirectory ? "Directory" : "File") << std::endl;
  }

  return 0;
}

C

#include <stdio.h>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  struct FileList files = GetFiles("/home/user/Documents");

  for (int i = 0; i < files.count; i++) {
    FileInfo *file = &files.files[i];
    printf("%s - %s\n", file->name, file->isDirectory ? "Directory" : "File");
  }

  return 0;
}

Node.js

import { getFiles } from "@kingmaj0r/filerix/lib";

const files = getFiles('/home/user/Documents');
files.forEach(file => {
  console.log(`${file.name} - ${file.isDirectory ? 'Directory' : 'File'}`);
});

Rust

use filerix::FileSystem::FileUtils;

fn main() {
  let files = FileUtils::get_files("/home/user/Documents");

  for file in files {
    println!("{} - {}", file.name, if file.is_directory { "Directory" } else { "File" });
  }
}

searchFiles()

• searchFiles(path: string, query: string): FileInfo[]
  • Description: Searches for files matching the query within a directory (recursively).
  • Parameters:
    • path (string): The directory to search.
    • query (string): The file name or pattern to search for.
  • Returns:
    • An array of FileInfo objects for matching files:
      • name (string): File name.
      • path (string): Full file path.
      • isDirectory (boolean): Whether it is a directory.
      • size (number): File size (in bytes).
  • Examples:

C++

#include <iostream>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  auto results = FileUtils::SearchFiles("/home/user/Documents", "project");

  for (const auto& file : results) {
    std::cout << file.name << " - " << file.path << std::endl;
  }

  return 0;
}

C

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  const char* search_dir = "/home/user/Documents";
  const char* search_term = "project";

  struct FileList result = SearchFiles(search_dir, search_term);

  for (size_t i = 0; i < result.count; i++) {
    printf("%s - %s\n", result.files[i].name, result.files[i].path);
  }

  return 0;
}

Node.js

import { searchFiles } from "@kingmaj0r/filerix/lib";

const results = searchFiles('/home/user/Documents', 'project');
results.forEach(file => {
  console.log(`${file.name} - ${file.path}`);
});

Rust

use filerix::FileSystem::FileUtils;

fn main() {
  let results = FileUtils::search_files("/home/user/Documents", "project");

  for file in results {
    println!("{} - {}", file.name, file.path);
  }
}

copyFile()

• copyFile(source: string, destination: string): boolean
  • Description: Copies a file or directory to a specified location.
  • Parameters:
    • source (string): Path to the source file or directory.
    • destination (string): Path to the destination file or directory.
  • Returns:
    • true if the operation was successful, otherwise false.
  • Examples:

C++

#include <iostream>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (FileUtils::Copy("/home/user/file.txt", "/home/user/Documents/file_copy.txt")) {
    std::cout << "File copied successfully." << std::endl;
  } else {
    std::cerr << "Failed to copy file." << std::endl;
  }

  return 0;
}

C

#include <stdio.h>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (Copy("/home/user/file.txt", "/home/user/Documents/file_copy.txt")) {
    printf("File copied successfully.\n");
  } else {
    fprintf(stderr, "Failed to copy file.\n");
  }

  return 0;
}

Node.js

import { copyFile } from "@kingmaj0r/filerix/lib";

if (copyFile('/home/user/file.txt', '/home/user/Documents/file_copy.txt')) {
  console.log('File copied successfully.');
} else {
  console.log('Failed to copy file.');
}

Rust

use filerix::FileSystem::FileUtils;

fn main() {
  if FileUtils::copy("/home/user/file.txt", "/home/user/Documents/file_copy.txt") {
    println!("File copied successfully.");
  } else {
    eprintln!("Failed to copy file.");
  }
}

cutFile()

• cutFile(source: string, destination: string): boolean
  • Description: Moves a file or directory to a new location (cut and paste).
  • Parameters:
    • source (string): Path to the source file or directory.
    • destination (string): Path to the destination file or directory.
  • Returns:
    • true if the operation was successful, otherwise false.
  • Examples:

C++

#include <iostream>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (FileUtils::Cut("/home/user/file.txt", "/home/user/Documents/file_moved.txt")) {
    std::cout << "File moved successfully." << std::endl;
  } else {
    std::cerr << "Failed to move file." << std::endl;
  }
  
  return 0;
}

C

#include <stdio.h>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (Cut("/home/user/file.txt", "/home/user/Documents/file_moved.txt")) {
    printf("File moved successfully.\n");
  } else {
    fprintf(stderr, "Failed to move file.\n");
  }

  return 0;
}

Node.js

import { cutFile } from "@kingmaj0r/filerix/lib";

if (cutFile('/home/user/file.txt', '/home/user/Documents/file_moved.txt')) {
  console.log('File moved successfully.');
} else {
  console.log('Failed to move file.');
}

Rust

use filerix::FileSystem::FileUtils;

fn main() {
  if FileUtils::cut("/home/user/file.txt", "/home/user/Documents/file_moved.txt") {
    println!("File moved successfully.");
  } else {
    eprintln!("Failed to moved file.");
  }
}

renameFile()

• renameFile(oldPath: string, newPath: string): boolean
  • Description: Renames or moves a file or directory.
  • Parameters:
    • oldPath (string): The current path of the file or directory.
    • newPath (string): The new path of the file or directory.
  • Returns:
    • true if the operation was successful, otherwise false.
  • Examples:

C++

#include <iostream>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (FileUtils::Rename("/home/user/file.txt", "/home/user/file_renamed.txt")) {
    std::cout << "File renamed successfully." << std::endl;
  } else {
    std::cerr << "Failed to rename file." << std::endl;
  }

  return 0;
}

C

#include <stdio.h>
#include "filerix/FileSystem/FileUtils.h"

int main() {
  if (Rename("/home/user/file.txt", "/home/user/file_renamed.txt")) {
    printf("File renamed successfully.\n");
  } else {
    fprintf(stderr, "Failed to rename file.\n");
  }

  return 0;
}

Node.js

import { renameFile } from "@kingmaj0r/filerix/lib";

if (renameFile('/home/user/file.txt', '/home/user/file_renamed.txt')) {
  console.log('File renamed successfully.');
} else {
  console.log('Failed to rename file.');
}

Rust

use filerix::FileSystem::FileUtils;

fn main() {
  if FileUtils::rename("/home/user/file.txt", "/home/user/Documents/file_rename.txt") {
    println!("File renamed successfully.");
  } else {
    eprintln!("Failed to rename file.");
  }
}