Struct plex_api::HttpClient

pub struct HttpClient {

    pub api_url: Uri,
    pub http_client: IsahcHttpClient,
    pub x_plex_provides: String,
    pub x_plex_platform: String,
    pub x_plex_platform_version: String,
    pub x_plex_product: String,
    pub x_plex_version: String,
    pub x_plex_device: String,
    pub x_plex_device_name: String,
    pub x_plex_client_identifier: String,
    pub x_plex_sync_version: String,
    pub x_plex_model: String,
    pub x_plex_features: String,
    pub x_plex_target_client_identifier: String,
    /* private fields */
}

Fields

api_url: Uri

http_client: IsahcHttpClient

x_plex_provides: String

X-Plex-Provides header value. Comma-separated list.

Should be one or more of controller, server, sync-target, player.

x_plex_platform: String

X-Plex-Platform header value.

Platform name, e.g. iOS, macOS, etc.

x_plex_platform_version: String

X-Plex-Platform-Version header value.

OS version, e.g. 4.3.1

x_plex_product: String

X-Plex-Product header value.

Application name, e.g. Laika, Plex Media Server, Media Link.

x_plex_version: String

X-Plex-Version header value.

Application version, e.g. 10.6.7.

x_plex_device: String

X-Plex-Device header value.

Device name and model number, e.g. iPhone3,2, Motorola XOOM™, LG5200TV.

x_plex_device_name: String

X-Plex-Device-Name header value.

Primary name for the device, e.g. “Plex Web (Chrome)”.

x_plex_client_identifier: String

X-Plex-Client-Identifier header value.

UUID, serial number, or other number unique per device.

N.B. Should be unique for each of your devices.

x_plex_sync_version: String

X-Plex-Sync-Version header value.

Not sure what are the valid values, but at the time of writing Plex Web sends 2 here.

x_plex_model: String

X-Plex-Model header value.

Plex Web sends hosted

x_plex_features: String

X-Plex-Features header value.

Looks like it’s a replacement for X-Plex-Provides

x_plex_target_client_identifier: String

X-Plex-Target-Client-Identifier header value.

Used when proxying a client request via a server.

Implementations

impl HttpClient

pub fn is_authenticated(&self) -> bool

Verifies that this client has an authentication token.

pub fn post<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Begins building a request using the HTTP POST method.

pub fn postm<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Does the same as HttpClient::post(), but appends only bare minimum headers: X-Plex-Client-Identifier and X-Plex-Token.

pub fn get<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Begins building a request using the HTTP GET method.

pub fn getm<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Does the same as HttpClient::get(), but appends only bare minimum headers: X-Plex-Client-Identifier and X-Plex-Token.

pub fn put<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Begins building a request using the HTTP PUT method.

pub fn putm<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Does the same as HttpClient::put(), but appends only bare minimum headers: X-Plex-Client-Identifier and X-Plex-Token.

pub fn delete<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Begins building a request using the HTTP DELETE method.

pub fn deletem<T>(&self, path: T) -> RequestBuilder<'_, T>where PathAndQuery: TryFrom<T>, <PathAndQuery as TryFrom<T>>::Error: Into<Error>,

Does the same as HttpClient::delete(), but appends only bare minimum headers: X-Plex-Client-Identifier and X-Plex-Token.

pub fn set_x_plex_token<T>(self, x_plex_token: T) -> Selfwhere T: Into<SecretString>,

Set the client’s authentication token.

pub fn x_plex_token(&self) -> &str

Get a reference to the client’s authentication token.

Trait Implementations

impl Clone for HttpClient

fn clone(&self) -> HttpClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpClient

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

Formats the value using the given formatter.

impl From<&HttpClient> for HttpClient

fn from(value: &HttpClient) -> Self

Converts to this type from the input type.