Struct lexoffice::ApiKey

pub struct ApiKey(_);

Represents an API Key

Implementations

impl ApiKey

pub fn from_env() -> Result<Self>

Loads the API key from the LEXOFFICE_KEY environment variable

pub async fn from_file(file_name: &Path) -> Result<Self>

Loads the API key from a specified file.

pub async fn from_home() -> Result<Self>

Loads the API key from the home folder containing a ~/.lexoffice file

pub async fn try_default() -> Result<Self>

This function tries to load a key from the following sources in this order:

1. The LEXOFFICE_KEY environment variable
2. The ~/.lexoffice file containing the key

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.

impl Display for ApiKey

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

Formats the value using the given formatter.

impl From<&'_ str> for ApiKey

fn from(s: &str) -> Self

Performs the conversion.

impl From<String> for ApiKey

fn from(original: String) -> ApiKey

Performs the conversion.

impl FromStr for ApiKey

type Err = <String as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.