Skip to main content

ReferenceYoutubeDownloadEnv

rsynko_memory

Struct ReferenceYoutubeDownloadEnv 

Source 
pub struct ReferenceYoutubeDownloadEnv { /* private fields */ }
Expand description

Retrieves the representation one Youtube media request states.

Publication, progress, and reporting are the shared download interpreter’s; only locating the bytes is Youtube-specific, so only that is stated here.

Implementations§

Source§

impl ReferenceYoutubeDownloadEnv

Source

pub fn register_resource( &mut self, url: impl Into<String>, bytes: impl Into<Vec<u8>>, )

Associates exact bytes with one media URL.

Source

pub fn file(&self, path: &Path) -> Option<Vec<u8>>

Observes bytes published at one final path.

Source

pub fn opened(&self) -> Vec<YoutubeRequest>

Observes the requests retrieval opened, in retrieval order.

Source

pub fn events(&self) -> Vec<DownloadEvent>

Observes terminal events in emission order.

Source

pub fn progress(&self) -> Vec<DownloadProgress>

Observes byte-progress reports in emission order.

Trait Implementations§

Source§

impl AtomicPublishAlg for ReferenceYoutubeDownloadEnv
where ReferenceDownloadEnv: AtomicPublishAlg,

Source§

type Error = <ReferenceDownloadEnv as AtomicPublishAlg>::Error

Denotes publication failure.
Source§

type Publication = <ReferenceDownloadEnv as AtomicPublishAlg>::Publication

Carries one unpublished destination representation.
Source§

fn begin_publication( &self, destination: &Path, ) -> Result<Self::Publication, Self::Error>

Begins publication without making the final destination observable. Read more
Source§

fn write_publication( &self, publication: &mut Self::Publication, bytes: &[u8], ) -> Result<(), Self::Error>

Appends bytes to an unpublished destination. Read more
Source§

fn commit_publication( &self, publication: Self::Publication, ) -> Result<(), Self::Error>

Atomically makes a complete publication observable at its final destination. Read more
Source§

fn abort_publication(&self, publication: Self::Publication)

Abandons an incomplete publication and removes its partial representation.
Source§

impl Debug for ReferenceYoutubeDownloadEnv

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ReferenceYoutubeDownloadEnv

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl DownloadObservationAlg for ReferenceYoutubeDownloadEnv
where ReferenceDownloadEnv: DownloadObservationAlg,

Source§

type Event = <ReferenceDownloadEnv as DownloadObservationAlg>::Event

Represents one terminal event.
Source§

type Progress = <ReferenceDownloadEnv as DownloadObservationAlg>::Progress

Represents one progress observation.
Source§

fn download_progress( &self, destination: &Path, downloaded: u64, total: Option<u64>, ) -> Self::Progress

Defines a byte-progress observation.
Source§

fn download_succeeded(&self, destination: &Path, bytes: u64) -> Self::Event

Defines terminal success.
Source§

fn download_failed(&self, destination: &Path, message: String) -> Self::Event

Defines terminal failure.
Source§

impl DownloadProgressAlg for ReferenceYoutubeDownloadEnv
where ReferenceDownloadEnv: DownloadProgressAlg,

Source§

type Progress = <ReferenceDownloadEnv as DownloadProgressAlg>::Progress

Represents one progress observation.
Source§

fn report_progress(&self, progress: Self::Progress)

Reports one monotonic byte-progress observation.
Source§

impl DownloadReportAlg for ReferenceYoutubeDownloadEnv
where ReferenceDownloadEnv: DownloadReportAlg,

Source§

type Event = <ReferenceDownloadEnv as DownloadReportAlg>::Event

Represents one terminal download event.
Source§

fn report_download(&self, event: Self::Event)

Reports one terminal event.
Source§

impl FetchStreamAlg<YoutubeRequest> for ReferenceYoutubeDownloadEnv

Source§

type Error = ReferenceFetchError

Denotes retrieval failure.
Source§

type Stream = Cursor<Vec<u8>>

Carries one interpreter-specific open resource stream.
Source§

fn open_fetch( &self, request: &YoutubeRequest, ) -> Result<FetchStream<Self::Stream>, Self::Error>

Opens a resource stream and observes its expected byte count when known. Read more
Source§

fn read_fetch( &self, stream: &mut Self::Stream, buffer: &mut [u8], ) -> Result<usize, Self::Error>

Reads the next resource bytes into a caller-owned buffer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<This, Source, FetchError, PublishError, Event, Progress> DownloadExt<This, Source, FetchError, PublishError, Event, Progress> for This
where This: FetchStreamAlg<Source, Error = FetchError> + AtomicPublishAlg<Error = PublishError> + DownloadObservationAlg<Event = Event, Progress = Progress> + DownloadProgressAlg<Progress = Progress> + DownloadReportAlg<Event = Event>, FetchError: Display, PublishError: Display, Source: ?Sized,

Source§

fn download_resource( &self, source: &Source, destination: &Path, ) -> Result<u64, DownloadError<FetchError, PublishError>>

Fetches, atomically publishes, and reports exactly one terminal event.

§Errors

Returns the fetch or publication failure after reporting it.

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<This> GaugeLaws<This> for This

Source§

fn gauge_laws(&self) -> Result<(), Error>

Checks that a gauge states a share without claiming more resolution than it has.

The laws checked are:

  1. a gauge occupies its stated width whatever share it states;
  2. no share is stated as filled before it is reached, and none is stated twice;
  3. nothing stated is nothing filled, and everything stated fills the whole track;
  4. the stated text occupies exactly one cell per counted cell.
§Errors

Returns the first violated law.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<This> IntoExt<This> for This

Source§

fn to<R>(self) -> R
where This: Into<R>,

A version of Into::into function that can be used to explicitly specify the target conversion type.

use alux_sdk::*;
// `Into` requires context to infer the type,
let _: i64 = Into::into(42_i8);
// The opposite `From` requires context to infer the type,
let _: i64 = From::from(42_i8);
// `.to()` can be used in the same way as a postfix function (the same as `.into()`),
let _: i64 = 42_i8.to();
// but also with the type specified explicitly.
let _ = 42_i8.to::<i64>();
// Especially useful to chain multiple conversions inline.
let _: i64 = 42_i8.to::<i16>().to::<i32>().into();
Source§

impl<This> IntoIteratorExt<This> for This

Source§

fn try_collect_vec<T, E>(self) -> Result<Vec<T>, E>
where This: Iterator<Item = Result<T, E>>,

A variant of the try_collect and collect_vec combined function from the Itertools library. The materialized value is a Vec inside a Result object.

Returns the first error without collecting later values.

use alux_sdk::*;

let values = [Ok::<_, &str>(1), Ok(2), Ok(3)]
    .into_iter()
    .try_collect_vec();

assert_eq!(values, Ok(vec![1, 2, 3]));
Source§

fn collect_exact<T>(self, n: usize) -> Option<Vec<T>>
where This: Iterator<Item = T>,

Takes exactly n elements from the iterator.

Returns Some(Vec<T>) if the iterator yields exactly n elements, otherwise returns None.

use alux_sdk::*;

let v = [1, 2, 3];

assert_eq!(v.iter().copied().collect_exact(3), Some(vec![1, 2, 3]));
assert_eq!(v.iter().copied().collect_exact(4), None);
assert_eq!(v.iter().copied().collect_exact(2), None);
Source§

fn try_unzip<A, B, E>(self) -> Result<(Vec<A>, Vec<B>), E>
where This: IntoIterator<Item = Result<(A, B), E>>,

Efficiently splits an iterator of Result<(A, B), E> into two Vecs, short-circuiting on error.

Consumes the iterator, collecting all A elements into one vector and all B elements into another, without first allocating an intermediate vector of tuples. Returns the tuple (Vec<A>, Vec<B>) on success, or the first error encountered.

use alux_sdk::*;

let input = vec![Ok((1, "x")), Ok((2, "y"))];
let (xs, ys) = input.try_unzip::<_, _, ()>().unwrap();

assert_eq!(xs, vec![1, 2]);
assert_eq!(ys, vec!["x", "y"]);
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.