Struct Auth 

pub struct Auth {
    pub token: Option<SecretString>,
}

Token authentication for Figshare API requests.

Fields

token: Option<SecretString>

API token used for authenticated requests, or None for anonymous access.

Implementations

impl Auth

pub const TOKEN_ENV_VAR: &'static str = "FIGSHARE_TOKEN"

Standard environment variable for a Figshare API token.

pub fn new(token: impl Into<String>) -> Self

Creates a new authentication wrapper from a raw token string.

pub fn anonymous() -> Self

Creates an anonymous authentication wrapper for public API calls.

Examples

use figshare_rs::Auth;

let auth = Auth::anonymous();
assert!(auth.is_anonymous());

pub fn from_env() -> Result<Self, FigshareError>

Reads a Figshare API token from Self::TOKEN_ENV_VAR.

Errors

Returns an error if the environment variable is missing or invalid.

pub fn from_env_var(name: &str) -> Result<Self, FigshareError>

Reads a Figshare API token from a custom environment variable.

Errors

Returns an error if the environment variable is missing or invalid.

pub fn is_anonymous(&self) -> bool

Returns whether this authentication wrapper is anonymous.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.

impl From<SecretBox<str>> for Auth

fn from(token: SecretString) -> Self

Converts to this type from the input type.