Struct streamlink::Stream

pub struct Stream { /* fields omitted */ }

Represents a stream of a specific kind on a specific url.

Methods

impl Stream

pub fn from_url(url: Url) -> Result<Self, Error>

pub fn from_string(s: String) -> Result<Self, Error>

pub fn name(&self) -> Option<&str>

Returns the name (aka ID) of the stream.

Examples

use streamlink::Stream;
use std::str::FromStr;

let stream = Stream::from_string("https://twitch.tv/gogcom".into()).unwrap();
assert_eq!("gogcom", stream.name().unwrap());

let stream = Stream::from_string("https://youtube.com/user/markiplierGAME".into()).unwrap();
assert_eq!("markiplierGAME", stream.name().unwrap());

pub fn status(&self) -> Result<StreamStatus, Error>

Checks if stream is online.

Examples

use streamlink::{Stream, StreamStatus};

let online_stream_url = Stream::from_string("https://twitch.tv/food".into()).unwrap();
assert_eq!(StreamStatus::Online, online_stream_url.status().unwrap());

let offline_stream_url = Stream::from_string("https://twitch.tv/some_offline_stream".into()).unwrap();
assert_eq!(StreamStatus::Offline, offline_stream_url.status().unwrap());

Errors

If youtube-dl failed to execute, [std::io::Error] will be returned.

Trait Implementations

impl Debug for Stream

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Stream

fn eq(&self, __arg_0: &Stream) -> bool

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

fn ne(&self, __arg_0: &Stream) -> bool

This method tests for !=.

impl Display for Stream

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

Formats the value using the given formatter.