4 releases
0.1.3 | Apr 5, 2024 |
---|---|
0.1.2 | Apr 5, 2024 |
0.1.1 | Apr 5, 2024 |
0.1.0 | Apr 4, 2024 |
#324 in Development tools
286 downloads per month
Used in waifu-vault-client
38KB
526 lines
Waifu Vault SDK
This is the official API bindings for interacting with the Waifu Vault API.
For more information on Terms of Service and usage policy, please refer to the above website.
Install
cargo add waifuvault
Usage
The following interactions are allowed:
Upload a File
The following options can be set when creating a WaifuUploadRequest
:
file
: Optional value to upload a file from diskurl
: Optional value to upload content from a URLbytes
: Optional value to upload raw bytesexpires
: Optional value to define the expiry time for the content- Valid values are:
m
,h
,d
- If not set, the content exists for as long as the retention policy of the service
- Valid values are:
hide_filename
: Optional flag to set to hide the filename from the URL generatedpassword
: Optional value to set if the content should be encrypted or notone_time_download
: Optional flag to set if the content should be deleted after first access
use waifuvault::{
ApiCaller,
api::{WaifuUploadRequest, WaifuResponse}
};
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let caller = ApiCaller::new();
// Upload a file from disk
let request = WaifuUploadRequest::new()
.file("/some/file/path") // Path to a file
.password("set a password") // Set a password
.one_time_download(true); // Delete after first access
let response = caller.upload_file(request).await?;
// Upload a file from a URL
let request = WaifuUploadRequest::new()
.url("https://some-website/image.jpg"); // URL to content
let response = caller.upload_file(request).await?;
// Upload a file from raw bytes
let data = std::fs::read("some/file/path")?;
let request = WaifuUploadRequest::new()
.bytes(data, "name-to-store.rs"); // Raw file content and name to store on the vault
let response = caller.upload_file(request).await?;
Ok(())
}
Get File Information
Retrieves information about a file stored with the API
This requires a token that is obtained from the response when uploading a file.
The following parameters can be set when using the WaifuGetRequest
:
token
: The token used to retrieve the fileformatted
: Optional flag to determine if the expiry time is human-readable
use waifuvault::{
ApiCaller,
api::WaifuGetRequest
};
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let caller = ApiCaller::new();
let request = WaifuGetRequest::new("some-waifu-vault-token");
let response = caller.file_info(request).await?;
Ok(())
}
Modify File Options
Modifies the options for a stored file in the API
The following parameters can be used to update a file's information:
password
: Sets a new password for a file- If a password already exists,
previous_password
must also be used
- If a password already exists,
previous_password
: The previous password for the file (required when setting a new password on encrypted content)custom_expiry
: Sets a new expiry time for the contenthide_filename
: Sets the flag to hide the filename from the URL
use waifuvault::{
ApiCaller,
api::WaifuModificationRequest
};
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let caller = ApiCaller::new();
let request = WaifuModificationRequest::new("some-waifu-vault-token")
.password("new_password") // Set a new password
.previous_password("old_password") // Old password
.custom_expiry("1h") // Set a new expiry
.hide_filename(true); // Hide the filename
let response = caller.update_file(request).await?;
// Do something with the response
Ok(())
}
Delete a File
Deletes a file using the API denoted by the content token.
use waifuvault::ApiCaller;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let caller = ApiCaller::new();
let response = caller.delete_file("some-waifu-token").await?;
Ok(())
}
Download a File
Downloads a file from the API with the given token
use waifuvault::ApiCaller;
use std::io::Write;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let caller = ApiCaller::new();
// Download a file with no password
let content = caller.download_file("https://waifuvault.moe/f/some-file.ext", None).await?;
let mut f = std::fs::File::create("downloaded_file.txt")?;
f.write_all(&content)?;
// Download a file with no password
let content = caller.download_file("https://waifuvault.moe/f/some-other-file.ext", Some("password".to_string())).await?;
let mut f = std::fs::File::create("downloaded_file2.txt")?;
f.write_all(&content)?;
Ok(())
}
Dependencies
~6–19MB
~286K SLoC