Struct Client

pub struct Client { /* private fields */ }

Client for the Neocities API.

This struct is used to make requests to the Neocities API. It can be built using the Client::builder() method, which returns a ClientBuilder struct.

let client = Client::builder()
   .auth(Auth::from("username:password"))
   .build()
   .unwrap();

Implementations

impl Client

Client for the Neocities API.

pub fn builder() -> ClientBuilder

Return a new ClientBuilder struct.

pub fn delete(&self, paths: &[&str]) -> Result<()>

Delete one or more files from the website.

pub fn info(&self) -> Result<Info>

Get the website info.

pub fn key(&self) -> Result<String>

Get an API key for the website.

pub fn list(&self) -> Result<Vec<ListEntry>>

List the files on the website.

pub fn upload(&self, files: &[(&str, &[u8])]) -> Result<()>

Upload one or more files to the website.

This method receives a list of tuples, each containing the path of the file and the contents of the file.

client.upload(&[
    ("/1st_file.txt", b"Contents of the first file"),
    ("/2nd_file.txt", b"Contents of the second file"),
])?;

pub fn has_allowed_extension(free_account: bool, path: &str) -> bool

Check whether the given path has an allowed extension for this account.

If the free_account field is set to true, this method will check that the file extension of the given path is in the list of allowed extensions. If the field is set to false, this method will always return true.

For more information, see https://neocities.org/site_files/allowed_types.

assert!(Client::has_allowed_extension(true, "hello.txt"));
assert!(!Client::has_allowed_extension(true, "hello.exe"));

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.