Enum Endpoint 

pub enum Endpoint {
    Production,
    Custom(Url),
}

Base API endpoint used by the client.

Variants

Production

The public Figshare production service.

Custom(Url)

A fully custom Figshare-compatible API base URL.

Tuple Fields

0: Url

Deployment root or base API URL, normalized to end in /v2/ when no path is supplied.

Implementations

impl Endpoint

pub fn base_url(&self) -> Result<Url, ParseError>

Returns the API base URL for this endpoint.

Errors

Returns an error if the configured URL cannot be parsed into a valid base URL.

Examples

use figshare_rs::Endpoint;

let endpoint = Endpoint::Custom("http://localhost:1234".parse()?);
assert_eq!(endpoint.base_url()?.as_str(), "http://localhost:1234/v2/");

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Default for Endpoint

fn default() -> Endpoint

Returns the “default value” for a type.

impl PartialEq for Endpoint

fn eq(&self, other: &Endpoint) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Endpoint

impl StructuralPartialEq for Endpoint