rust-wistia 0.8.0

A rust crate wrapping Wistia's Data and Upload API into a simple easy to use interface
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use crate::models::Media;
use std::path::{Path, PathBuf};

/// Represents a request to download an [Asset URL].
///
/// [Asset URL]: https://wistia.com/support/developers/asset-urls
///
#[derive(Default)]
pub struct DownloadAssetRequest<'a> {
    /// The Wistia media to download.
    pub media_id: Option<&'a str>,

    /// The Wistia media to download.
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// use rust_wistia::models::DownloadAssetRequest;
    /// use rust_wistia::WistiaClient;
    ///
    /// let media = WistiaClient::from_env()?.get_media("my-id").await?;
    /// let info = DownloadAssetRequest::from(media);
    /// ```    
    pub media: Option<Media>,

    /// The media *asset type* to download.
    pub asset_type: Option<&'a str>,

    /// Sets a local *file path* to save the downloaded media content to.
    pub file_path: Option<PathBuf>,
}

impl<'a> From<&'a str> for DownloadAssetRequest<'a> {
    /// Create a new `DownloadAssetRequest` from a Wistia `media_id`
    fn from(media_id: &'a str) -> Self {
        Self {
            media_id: Some(media_id),
            ..Default::default()
        }
    }
}

impl<'a> From<&'a String> for DownloadAssetRequest<'a> {
    /// Create a new `DownloadAssetRequest` from a Wistia `media_id`
    fn from(media_id: &'a String) -> Self {
        Self {
            media_id: Some(media_id),
            ..Default::default()
        }
    }
}

impl<'a> From<Media> for DownloadAssetRequest<'a> {
    /// Create a new `DownloadAssetRequest` from a `Media` object
    fn from(media: Media) -> Self {
        Self {
            media: Some(media),
            ..Default::default()
        }
    }
}

impl<'a> DownloadAssetRequest<'a> {
    /// Sets the media *asset type* to download from Wistia.
    ///
    /// # Examples
    ///
    /// ```
    /// use rust_wistia::models::DownloadAssetRequest;
    ///
    /// let info = DownloadAssetRequest::from("my-video-id").asset_type("OriginalFile");
    /// ```    
    pub fn asset_type(mut self, asset_type: &'a str) -> Self {
        self.asset_type = Some(asset_type);
        self
    }

    /// Sets a local *file path* to save the downloaded media content to.
    ///
    /// # Examples
    ///
    /// ```rust,ignore
    /// use rust_wistia::models::DownloadAssetRequest;
    /// use rust_wistia::WistiaClient;
    ///
    /// let info = DownloadAssetRequest::from("my-video-id").file_path("./my-file.mp4");
    /// let _ = WistiaClient::from_env()?.download_asset(info).await?;
    /// ```    
    pub fn file_path(mut self, file_path: impl AsRef<Path>) -> Self {
        self.file_path = Some(file_path.as_ref().into());
        self
    }
}