Struct XtreamClient 

pub struct XtreamClient { /* private fields */ }

Async client for the Xtream Codes API.

Wraps a reqwest::Client (connection pooled) and caches the user profile after the first authentication call.

Implementations

impl XtreamClient

pub fn new(creds: XtreamCredentials) -> Result<Self, XtreamError>

Create a new client with the given credentials and default configuration.

pub fn with_config( creds: XtreamCredentials, config: XtreamClientConfig, ) -> Result<Self, XtreamError>

Create a new client with explicit configuration.

pub fn with_http_client( http: Client, creds: XtreamCredentials, config: XtreamClientConfig, ) -> Self

Create a client from an existing reqwest::Client (useful for sharing a connection pool across multiple crates).

pub fn base_url(&self) -> &str

The base URL of the Xtream server.

pub fn username(&self) -> &str

The username used for authentication.

pub fn preferred_format(&self) -> StreamFormat

The configured preferred stream format.

pub async fn authenticate(&self) -> Result<XtreamProfile, XtreamError>

Authenticate with the server and cache the profile.

This is called implicitly by methods that need the user profile (channel/VOD listings), but you can call it explicitly to verify credentials early.

pub async fn get_user_profile(&self) -> Result<XtreamUserProfile, XtreamError>

Get the cached user profile, authenticating first if needed.

pub async fn get_live_categories( &self, ) -> Result<Vec<XtreamCategory>, XtreamError>

Fetch live channel categories.

pub async fn get_vod_categories( &self, ) -> Result<Vec<XtreamCategory>, XtreamError>

Fetch VOD (movie) categories.

pub async fn get_series_categories( &self, ) -> Result<Vec<XtreamCategory>, XtreamError>

Fetch series categories.

pub async fn get_live_streams( &self, category_id: Option<&str>, ) -> Result<Vec<XtreamChannel>, XtreamError>

Fetch live channels, optionally filtered by category.

Stream URLs are automatically generated and attached to each channel.

pub async fn get_vod_streams( &self, category_id: Option<&str>, ) -> Result<Vec<XtreamMovieListing>, XtreamError>

Fetch VOD (movie) listings, optionally filtered by category.

Stream URLs are automatically generated and attached.

pub async fn get_vod_info( &self, vod_id: i64, ) -> Result<XtreamMovie, XtreamError>

Fetch detailed information about a specific movie.

pub async fn get_series( &self, category_id: Option<&str>, ) -> Result<Vec<XtreamShowListing>, XtreamError>

Fetch series listings, optionally filtered by category.

pub async fn get_series_info( &self, series_id: i64, ) -> Result<XtreamShow, XtreamError>

Fetch detailed information about a specific series, including seasons and episodes. Episode stream URLs are automatically attached.

pub async fn get_short_epg( &self, stream_id: i64, limit: Option<u32>, ) -> Result<XtreamShortEpg, XtreamError>

Fetch short EPG for a channel, with an optional entry limit.

Base64-encoded titles and descriptions are decoded transparently.

pub async fn get_full_epg( &self, stream_id: i64, ) -> Result<XtreamFullEpg, XtreamError>

Fetch full EPG for a channel.

Base64-encoded titles and descriptions are decoded transparently.

pub fn stream_url( &self, stream_type: StreamType, stream_id: i64, extension: &str, ) -> String

Build a stream URL for a given content type and ID.

pub fn xmltv_url(&self) -> String

Build the XMLTV EPG URL.

pub fn timeshift_url( &self, stream_id: i64, duration_minutes: u32, start: &str, ) -> String

Build a timeshift/catchup URL.

Trait Implementations

impl Clone for XtreamClient

fn clone(&self) -> XtreamClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XtreamClient

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

Formats the value using the given formatter.