Crates.io | remotefs-smb |
lib.rs | remotefs-smb |
version | 0.2.1 |
source | src |
created_at | 2022-05-27 14:52:50.712851 |
updated_at | 2023-12-15 18:03:22.761851 |
description | remotefs SMB client library |
homepage | https://veeso.github.io/remotefs-rs-smb/ |
repository | https://github.com/veeso/remotefs-rs-smb |
max_upload_size | |
id | 595096 |
size | 86,869 |
Changelog ยท Get started ยท Documentation
~ Remotefs SMB client ~
Developed by @veeso
Current version: 0.2.1 (15/12/2023)
remotefs-smb is a client implementation for remotefs, providing support for the SMB protocol.
First of all, add remotefs-smb
to your project dependencies:
remotefs-smb = "^0.2"
these features are supported:
find
: enable find()
method on client (enabled by default)no-log
: disable logging. By default, this library will log via the log
crate.remotefs-smb relies on pavao
, which requires the libsmbclient
library, which can be installed with the following instructions:
Install samba with brew:
brew install samba
Install libsmbclient with apt:
apt install -y libsmbclient-dev libsmbclient
โ ๏ธ libsmbclient-dev
is required only on the machine where you build the application
Install libsmbclient with dnf:
dnf install libsmbclient-devel libsmbclient
โ ๏ธ libsmbclient-devel
is required only on the machine where you build the application
Install libsmbclient building from sources:
wget -O samba.tar.gz https://github.com/samba-team/samba/archive/refs/tags/samba-4.16.1.tar.gz
mkdir -p samba/
tar xzvf samba.tar.gz -C samba/ --strip-components=1
rm samba.tar.gz
cd samba/
./configure
make
make install
cd ..
rm -rf samba/
// import remotefs trait and client
use remotefs::{RemoteFs, fs::UnixPex};
use remotefs_smb::{SmbFs, SmbOptions, SmbCredentials};
use std::path::Path;
let mut client = SmbFs::try_new(
SmbCredentials::default()
.server("smb://localhost:3445")
.share("/temp")
.username("test")
.password("test")
.workgroup("pavao"),
SmbOptions::default()
.case_sensitive(true)
.one_share_per_server(true),
)
.unwrap();
// connect
assert!(client.connect().is_ok());
// get working directory
println!("Wrkdir: {}", client.pwd().ok().unwrap().display());
// make directory
assert!(client.create_dir(Path::new("/cargo"), UnixPex::from(0o755)).is_ok());
// change working directory
assert!(client.change_dir(Path::new("/cargo")).is_ok());
// disconnect
assert!(client.disconnect().is_ok());
// import remotefs trait and client
use remotefs::{RemoteFs, fs::UnixPex};
use remotefs_smb::{SmbFs, SmbCredentials};
use std::path::Path;
let mut client = SmbFs::new(
SmbCredentials::new("localhost:3445", "temp")
.username("test")
.password("test")
);
// connect
assert!(client.connect().is_ok());
// get working directory
println!("Wrkdir: {}", client.pwd().ok().unwrap().display());
// make directory
assert!(client.create_dir(Path::new("\\cargo"), UnixPex::from(0o755)).is_ok());
// change working directory
assert!(client.change_dir(Path::new("\\cargo")).is_ok());
// disconnect
assert!(client.disconnect().is_ok());
The following table states the compatibility for the client client and the remote file system trait method.
Note: connect()
, disconnect()
and is_connected()
MUST always be supported, and are so omitted in the table.
Client/Method | Support (UNIX) | Support (Win ) |
---|---|---|
append_file | Yes | Yes |
append | No | Yes |
change_dir | Yes | Yes |
copy | No | Yes |
create_dir | Yes | Yes |
create_file | Yes | Yes |
create | No | Yes |
exec | No | No |
exists | Yes | Yes |
list_dir | Yes | Yes |
mov | Yes | Yes |
open_file | Yes | Yes |
open | No | Yes |
pwd | Yes | Yes |
remove_dir_all | Yes | Yes |
remove_dir | Yes | Yes |
remove_file | Yes | Yes |
setstat | No | Yes |
stat | Yes | Yes |
symlink | Yes | Yes |
If you like remotefs-smb and you're grateful for the work I've done, please consider a little donation ๐ฅณ
You can make a donation with one of these platforms:
Contributions, bug reports, new features, and questions are welcome! ๐ If you have any questions or concerns, or you want to suggest a new feature, or you want just want to improve remotefs, feel free to open an issue or a PR.
Please follow our contributing guidelines
View remotefs' changelog HERE
remotefs-smb is powered by these aweseome projects:
remotefs-smb is licensed under the MIT license.
You can read the entire license HERE