Struct torrust_tracker_configuration::HttpApi

pub struct HttpApi {
    pub enabled: bool,
    pub bind_address: String,
    pub ssl_enabled: bool,
    pub ssl_cert_path: Option<String>,
    pub ssl_key_path: Option<String>,
    pub access_tokens: HashMap<String, String>,
}

Configuration for the HTTP API.

Fields

enabled: bool

Weather the HTTP API is enabled or not.

bind_address: String

The address the tracker will bind to. The format is ip:port, for example 0.0.0.0:6969. If you want to listen to all interfaces, use 0.0.0.0. If you want the operating system to choose a random port, use port 0.

ssl_enabled: bool

Weather the HTTP API will use SSL or not.

ssl_cert_path: Option<String>

Path to the SSL certificate file. Only used if ssl_enabled is true.

ssl_key_path: Option<String>

Path to the SSL key file. Only used if ssl_enabled is true.

access_tokens: HashMap<String, String>

Access tokens for the HTTP API. The key is a label identifying the token and the value is the token itself. The token is used to authenticate the user. All tokens are valid for all endpoints and have the all permissions.

Implementations

impl HttpApi

pub fn contains_token(&self, token: &str) -> bool

Checks if the given token is one of the token in the configuration.

Trait Implementations

impl Clone for HttpApi

fn clone(&self) -> HttpApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpApi

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpApi

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<HttpApi> for HttpApi

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for HttpApi

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HttpApi

impl StructuralEq for HttpApi

impl StructuralPartialEq for HttpApi