oceanpkg 0.0.11

Client library for the Ocean package manager.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! Interfacing with Ocean's web API.

use std::{
    borrow::Cow,
    env::{self, VarError},
    ffi::{OsStr, OsString},
};
use url::Url;

pub mod v1;

/// The default URL to which API calls are made: `https://api.oceanpkg.org/`.
pub const DEFAULT_URL: &str = "https://api.oceanpkg.org/";

/// The environment variable key for using an alternative API URL:
/// `OCEAN_API_URL`.
pub const URL_ENV_KEY: &str = crate::env::OCEAN_API_URL;

/// Returns the parsed `Url` value for [`URL_ENV_VAR`] or [`DEFAULT_URL`] if it
/// does not exist.
///
/// [`URL_ENV_VAR`]: constant.URL_ENV_VAR.html
/// [`DEFAULT_URL`]: constant.DEFAULT_URL.html
pub fn url() -> Result<Url, url::ParseError> {
    match url_str() {
        Ok(url) => Url::parse(&url),
        Err(_) => Err(url::ParseError::InvalidDomainCharacter),
    }
}

/// Returns the UTF-8 encoded value for [`URL_ENV_VAR`] or [`DEFAULT_URL`] if it
/// does not exist.
///
/// [`URL_ENV_VAR`]: constant.URL_ENV_VAR.html
/// [`DEFAULT_URL`]: constant.DEFAULT_URL.html
pub fn url_str() -> Result<Cow<'static, str>, OsString> {
    match env::var(URL_ENV_KEY) {
        Ok(var) => Ok(Cow::Owned(var)),
        Err(VarError::NotPresent) => Ok(Cow::Borrowed(DEFAULT_URL)),
        Err(VarError::NotUnicode(var)) => Err(var),
    }
}

/// Returns the OS encoded value for [`URL_ENV_VAR`] or [`DEFAULT_URL`] if it
/// does not exist.
///
/// [`URL_ENV_VAR`]: constant.URL_ENV_VAR.html
/// [`DEFAULT_URL`]: constant.DEFAULT_URL.html
pub fn url_os_str() -> Cow<'static, OsStr> {
    if let Some(var) = env::var_os(URL_ENV_KEY) {
        Cow::Owned(var)
    } else {
        Cow::Borrowed(DEFAULT_URL.as_ref())
    }
}