Struct Client 

pub struct Client { /* private fields */ }

The network client to use to interact with the Etebase server

This is in charge of actually connecting to the server and making network requests. If the "networking" crate feature is enabled, it uses an internal HTTP client based on the reqwest crate. If the feature is not enabled, an external HTTP(S) client implementation implementing the ClientImplementation trait needs to be supplied.

Implementations

impl Client

pub fn new(client_name: &str, server_url: &str) -> Result<Self>

Creates a new client object for the server located at server_url.

The client_name will be used to populate the User-Agent header in all requests to the server.

Examples

use etebase::Client;

// For an application called "FancyClient"
let my_client = Client::new("FancyClient", "https://myhost.example");

Examples found in repository

examples/etebase_test.rs (line 34)

fn main() -> Result<()> {
    let args: Vec<String> = env::args().collect();

    if args.len() < 4 {
        println!("Help: ./etebase_test USERNAME PASSWORD SERVER_URL [COLLECTION_UID]");
        std::process::exit(1);
    }

    let username = &args[1];
    let password = &args[2];
    let server_url = &args[3];

    let client = Client::new(CLIENT_NAME, server_url)?;
    let etebase = Account::login(client, username, password)?;
    let col_mgr = etebase.collection_manager()?;
    if args.len() >= 5 {
        let col_uid = &args[4];
        let col = col_mgr.fetch(col_uid, None)?;
        let it_mgr = col_mgr.item_manager(&col)?;
        let items = it_mgr.list(None)?;

        print_collection(&col);
        for item in items.data() {
            print_item(item);
        }
    } else {
        let collections = col_mgr.list("some.coltype", None)?;
        for col in collections.data() {
            print_collection(col);
        }
    }

    etebase.logout()?;

    Ok(())
}

pub fn is_server_valid(&self) -> Result<bool>

Checks whether the Client is pointing to a valid Etebase server.

Examples

use etebase::Client;

let invalid_client = Client::new("ExampleClient", "https://example.com").unwrap();
assert!(!invalid_client.is_server_valid().unwrap());

let valid_client = Client::new("ExampleClient", "https://api.etebase.com/").unwrap();
assert!(valid_client.is_server_valid().unwrap());

pub fn set_server_url(&mut self, server_url: &str) -> Result<()>

Set the server url associated with this client

Examples

use etebase::Client;

let mut client = Client::new("ExampleClient", "https://invalid.example").unwrap();
client.set_server_url("https://another.example");

assert_eq!(client.server_url().to_string(), "https://another.example/");

pub fn server_url(&self) -> &Url

Return the server url associated with this client

Examples

use etebase::Client;

let client = Client::new("ExampleClient", "https://invalid.example").unwrap();

assert_eq!(client.server_url().to_string(), "https://invalid.example/");

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.