Crate crunchyroll_rs

Expand description

§crunchyroll-rs

An easy-to-use, batteries-included library for the undocumented Crunchyroll api, completely written in Rust.

You can use a premium account as well as a non-premium account to use this library, but you will be limited to your account tier access privileges (=> you can’t access a premium-only series with a free account).

The library has some features to ensure a flawless experience in a ⚡🦀 blazingly fast environment.

Full Tokio compatibility.
Solid tests to ensure api compatability.

§Getting started

Before you can do anything, you have to instantiate a new Crunchyroll struct at first. This internally creates a new crunchyroll::CrunchyrollBuilder instance. All functions of this struct are chaining, which means you can build a working Crunchyroll instance in one expression.

use crunchyroll_rs::{Crunchyroll, Locale};

let crunchy = Crunchyroll::builder()
    // set the language in which results should be returned
    .locale(Locale::en_US)
    // login with user credentials (other login options are also available)
    // support for username login was dropped by Crunchyroll on December 6th, 2023
    .login_with_credentials("email", "password")
    .await?;

§Request media

You can request media like series, episodes, movies, … with their corresponding function in the Crunchyroll struct. Use Crunchyroll::*_from_id to get them while * is the media type.

// get the series with the id 'GY8VEQ95Y'
let series: Series = crunchy.media_from_id("GY8VEQ95Y").await?;

// get the episode with the id 'GRDKJZ81Y'
let episode: Episode = crunchy.media_from_id("GY8VEQ95Y").await?;

If you want to get the children of a “container” media like a series or season, these types implements the appropriate functions to archive this.

let seasons = series
    // get the seasons of this series
    .seasons()
    .await?;

§Streaming

All streams are DRM protected. The library does not contain logic to decrypt it, so if you want to do this, you have to implement it yourself.

This crate allows you to get the actual video streams behind episodes and movies.

let stream = episode
    .stream()
    .await?;

Crunchyroll uses the DASH video streaming format to distribute their streams. The logic to work with these formats is already implemented into this crate.

let mut stream_data = stream
    .stream_data(None)
    .await?
    .unwrap();

 // sort the streams to get the stream with the best resolution / bitrate at first
stream_data.video.sort_by(|a, b| a.bandwidth.cmp(&b.bandwidth).reverse());
stream_data.audio.sort_by(|a, b| a.bandwidth.cmp(&b.bandwidth).reverse());

let sink = &mut std::io::sink();

// get the segments / video chunks of the first stream (which is the best after it got sorted
// above)
let video_segments = stream_data.video[0].segments();
let audio_segments = stream_data.audio[0].segments();
// iterate through every segment and write it to the provided writer (which is a sink in this
// case; it drops its input immediately). writer can be anything which implements `std::io::Write`
// like a file, a pipe, ...
for video_segment in video_segments {
    sink.write_all(&video_segment.data().await?)?;
}
for audio_segment in audio_segments {
    sink.write_all(&audio_segment.data().await?)?;
}

§Bugs

Crunchyroll is awful in keep their api clean. Thus, some things are broken, will break for no reason or aren’t well implemented (if at all). The methods added with the experimental-stabilizations feature (CrunchyrollBuilder::stabilization_*) can be used to prevent some issues. Note that there is no guarantee that these functions will work or that they will not break anything.

§Cloudflare

Crunchyroll uses the cloudflare bot protection to detect if requests are made by a human. Obviously this crate makes automated requests and thus, Cloudflare sometimes blocks requests. The crate catches these errors with the error::Error::Block enum field. The block occurs depending on different factors like your location. If such a block occurs you can try to create a custom reqwest::Client which has the needed configuration to bypass this check, like other user agents or tls backends (note that reqwest currently only supports native-tls besides rustls as tls backend, which is confirmed to work with openssl on Linux only, on Windows the blocks are even more aggressive). The configurations may vary on the factors addressed so there is no 100% right way to do it.

§Features

parse (enabled by default): Enables url parsing.
tower: Enables the usage of a tower compatible middleware.
experimental-stabilizations: Provides some functions to maybe fix broken api results. See Bugs for more information.

§Implementation

To ensure at least all existing parts of the library are working as expected, a special feature only for testing is implemented. When running tests with the __test_strict feature, it ensures that no fields were added or removed from an api response, otherwise the associated test will fail.

Re-exports§

pub use crunchyroll::Crunchyroll;
pub use crunchyroll::Locale;
pub use media::Concert;
pub use media::Episode;
pub use media::MediaCollection;
pub use media::Movie;
pub use media::MovieListing;
pub use media::MusicVideo;
pub use media::Season;
pub use media::Series;
pub use parse::UrlType;
pub use parse::parse_url;

Modules§

account: Account specific actions.
categories: Media categories.
common: Commonly used types.
crunchyroll: Builder and access to the Crunchyroll struct which is required to make any action.
devices: Device management.
error: Library specific errors.
feed: Feeds like home feed or news feed.
list: Crunchylists, watchlists and watch history.
media: All media items like series, episodes or movies.
parseparse: Url parsing.
profile: Multiprofiles.
search: Browse and search related types.

Crate crunchyroll_rsCopy item path