Struct RuntimeEnvironment 

pub struct RuntimeEnvironment { /* private fields */ }

Interprets exact requests, fixture bytes, atomic files, and runtime observations.

Implementations

impl RuntimeEnvironment

pub fn build() -> Result<Self, Error>

Constructs the production environment and its HTTP client.

Errors

Returns failure to construct the Rustls-backed client.

pub fn build_observed(observer: RuntimeObservationSender) -> Result<Self, Error>

Constructs the production environment with a live observation channel.

Errors

Returns failure to construct the Rustls-backed client.

pub fn build_pausable( observer: RuntimeObservationSender, pause: RuntimePause, ) -> Result<Self, Error>

Constructs the production environment with observation and cooperative pause control.

Errors

Returns failure to construct the Rustls-backed client.

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

Observes terminal download events in emission order.

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

Observes byte-progress reports in emission order.

Trait Implementations

impl AtomicPublishAlg for RuntimeEnvironment

type Error = Error

Denotes publication failure.

type Publication = RuntimePublication

Carries one unpublished destination representation.

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

Begins publication without making the final destination observable.

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

Appends bytes to an unpublished destination.

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

Atomically makes a complete publication observable at its final destination.

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

Abandons an incomplete publication and removes its partial representation.

impl Debug for RuntimeEnvironment

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

Formats the value using the given formatter.

impl DownloadObservationAlg for RuntimeEnvironment

type Event = DownloadEvent

Represents one terminal event.

type Progress = DownloadProgress

Represents one progress observation.

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

Defines a byte-progress observation.

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

Defines terminal success.

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

Defines terminal failure.

impl DownloadProgressAlg for RuntimeEnvironment

type Progress = DownloadProgress

Represents one progress observation.

fn report_progress(&self, progress: DownloadProgress)

Reports one monotonic byte-progress observation.

impl DownloadReportAlg for RuntimeEnvironment

type Event = DownloadEvent

Represents one terminal download event.

fn report_download(&self, event: DownloadEvent)

Reports one terminal event.

impl ExtractionAlg for RuntimeEnvironment

fn media( &self, id: impl Into<String>, metadata: Self::Metadata, formats: impl IntoIterator<Item = Self::Format>, ) -> Self::Extraction

Defines a fully described media extraction.

fn url_reference( &self, url: impl Into<String>, extractor: Option<Self::Extractor>, transparent: bool, ) -> Self::Extraction

Defines a URL requiring another extraction step.

fn extraction_collection( &self, id: Option<String>, kind: CollectionKind, metadata: Self::Metadata, entries: impl IntoIterator<Item = Self::Extraction>, ) -> Self::Extraction

Defines an ordered extraction collection.

impl ExtractionApplyAlg for RuntimeEnvironment

type Error = RuntimeExtractionError

Denotes an extractor-specific failure.

fn extract_with( &self, extractor: &ExtractorKey, url: &str, ) -> Result<Extraction, Self::Error>

Applies a selected extractor to an accepted URL.

impl ExtractionCatalogAlg for RuntimeEnvironment

fn extractor_keys(&self) -> impl Iterator<Item = &ExtractorKey>

Observes extractor keys in selection order.

fn extractor_accepts(&self, extractor: &ExtractorKey, url: &str) -> bool

Observes whether one extractor accepts an input URL.

impl ExtractionViewAlg for RuntimeEnvironment

fn as_media(&self, extraction: Extraction) -> Option<Media>

Observes the single media item an extraction denotes, exactly when it denotes one.

impl FetchStreamAlg for RuntimeEnvironment

type Error = RuntimeFetchError

Denotes retrieval failure.

type Stream = RuntimeFetchStream

Carries one interpreter-specific open resource stream.

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

Opens a resource stream and observes its expected byte count when known.

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.

impl FetchStreamAlg<String> for RuntimeEnvironment

type Error = RuntimeFetchError

Denotes retrieval failure.

type Stream = RuntimeFetchStream

Carries one interpreter-specific open resource stream.

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

Opens a resource stream and observes its expected byte count when known.

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.

impl FetchStreamAlg<YoutubeRequest> for RuntimeEnvironment

type Error = RuntimeFetchError

Denotes retrieval failure.

type Stream = RuntimeFetchStream

Carries one interpreter-specific open resource stream.

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

Opens a resource stream and observes its expected byte count when known.

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.

impl FormatAlg for RuntimeEnvironment

fn format( &self, id: impl Into<String>, metadata: Self::Metadata, ) -> Self::Format

Defines one representation from its identity and everything observed about it.

impl FormatPredicateMatchAlg for RuntimeEnvironment

fn format_matches(&self, predicate: &FormatPredicate, format: &Format) -> bool

Observes whether a format satisfies a predicate.

impl FormatSelectionApplyAlg for RuntimeEnvironment

fn select_formats<'a>( &self, formats: &'a [Format], selection: &FormatSelection, ) -> Option<Vec<&'a Format>>

Chooses the formats one program denotes, in program order.

impl FormatSourceAlg<String> for RuntimeEnvironment

fn format_source(&self, format: &Format) -> Option<String>

Defines the source consumed by resource retrieval for one format.

impl FormatSourceAlg<YoutubeRequest> for RuntimeEnvironment

fn format_source(&self, format: &Format) -> Option<YoutubeRequest>

Defines the source consumed by resource retrieval for one format.

impl FormatViewAlg for RuntimeEnvironment

fn format_text<'a>(&self, format: &'a Format, key: &str) -> Option<&'a str>

Observes one named value of a format as text.

impl MediaSorts for RuntimeEnvironment

type Value = InfoValue

Represents one metadata value.

type Metadata = InfoRecord

Represents one metadata record.

type Format = Format

Represents one alternative representation of a media item.

type Artifact = Artifact

Represents one produced artifact.

type Media = Media

Represents one fully described media item.

type Extraction = Extraction

Represents one extraction result.

type Extractor = ExtractorKey

Represents one extractor identity.

type Predicate = FormatPredicate

Represents one predicate over a format.

type Selection = FormatSelection

Represents one format-selection program.

type Output = PathBuf

Represents one portable output name.

impl MediaViewAlg for RuntimeEnvironment

fn media_id<'a>(&self, media: &'a Media) -> &'a str

Observes the media identity.

fn media_title<'a>(&self, media: &'a Media) -> Option<&'a str>

Observes the media title exactly when one was extracted.

fn media_formats<'a>(&self, media: &'a Media) -> &'a [Format]

Observes the formats in extractor order.

impl MetadataAlg for RuntimeEnvironment

fn empty_metadata(&self) -> Self::Metadata

Defines the neutral metadata record.

fn null_metadata(&self) -> Self::Value

Defines unavailable metadata.

fn boolean_metadata(&self, value: bool) -> Self::Value

Defines a boolean observation.

fn integer_metadata(&self, value: i64) -> Self::Value

Defines an integral observation.

fn float_metadata(&self, value: f64) -> Self::Value

Defines a non-integral observation.

fn string_metadata(&self, value: impl Into<String>) -> Self::Value

Defines textual metadata.

fn list_metadata( &self, values: impl IntoIterator<Item = Self::Value>, ) -> Self::Value

Defines an ordered metadata sequence.

fn record_metadata(&self, record: Self::Metadata) -> Self::Value

Defines a nested metadata record.

fn metadata( &self, fields: impl IntoIterator<Item = (String, Self::Value)>, ) -> Self::Metadata

Defines a record from fields, with later equal keys replacing earlier fields.

impl XRequestAlg for RuntimeEnvironment

fn tweet_request(&self, address: impl Into<String>) -> String

Defines the request asking one address what it holds.

impl XRequestViewAlg for RuntimeEnvironment

fn request_address<'a>(&self, request: &'a String) -> &'a str

Observes the address the request asks.

impl XSorts for RuntimeEnvironment

type Request = String

Represents exactly the request that asks what one tweet carries.

type Attachment = Format

Represents one file a tweet carries.

impl YoutubeChallengeAlg for RuntimeEnvironment

type Error = !

Denotes resolution failure.

fn solve_challenges( &self, program: &str, challenges: impl IntoIterator<Item = YoutubeChallenge>, ) -> Result<Self::Solutions, Self::Error>

Resolves the given challenges together under the program that poses them.

impl YoutubeClientAlg for RuntimeEnvironment

fn player_clients(&self) -> impl Iterator<Item = &str>

Names the clients this interpreter can claim to be, in preference order.

impl YoutubeProgramAlg for RuntimeEnvironment

fn program_timestamp(&self, program: &str) -> Option<i64>

Observes the signature timestamp the program states, when it states one.

impl YoutubeRequestAlg for RuntimeEnvironment

fn watch_request(&self, url: impl Into<String>) -> Self::Request

Defines watch-page retrieval.

fn player_request( &self, id: impl Into<String>, api_key: impl Into<String>, claim: &PlayerClaim, ) -> Self::Request

Defines player-catalog retrieval under what the client claims about itself.

fn player_program_request(&self, url: impl Into<String>) -> Self::Request

Defines player-program retrieval.

fn media_request(&self, url: impl Into<String>) -> Self::Request

Defines direct-media retrieval.

impl YoutubeRequestBytesAlg for RuntimeEnvironment

type Error = RuntimeFetchError

Denotes request execution failure.

fn youtube_request_bytes( &self, request: &YoutubeRequest, ) -> Result<Vec<u8>, Self::Error>

Retrieves response bytes without changing request meaning.

impl YoutubeResponseAlg for RuntimeEnvironment

type Error = Error

Denotes decoding failure.

fn decode_youtube_watch( &self, bytes: &[u8], ) -> Result<YoutubeWatchPage, Self::Error>

Decodes one watch page.

fn decode_youtube_player( &self, bytes: &[u8], ) -> Result<YoutubePlayer, Self::Error>

Decodes one player response.

impl YoutubeSolutionAlg for RuntimeEnvironment

fn solution_of( &self, solutions: &Self::Solutions, challenge: &YoutubeChallenge, ) -> Option<String>

Observes the solution of one challenge exactly when that challenge was resolved.

impl YoutubeSorts for RuntimeEnvironment

type Request = YoutubeRequest

Represents one Youtube request.

type Solutions = YoutubeSolutions

Represents the challenges resolved by one bulk application.

impl YoutubeUrlAlg for RuntimeEnvironment

fn throttle_challenge(&self, url: &str) -> Option<String>

Observes the throttling challenge a representation URL carries.

fn with_throttle(&self, url: &str, solution: &str) -> String

Replaces the throttling parameter with its solution.

fn with_signature(&self, url: &str, parameter: &str, signature: &str) -> String

Attaches a solved signature under the parameter naming it.