Struct MediaSyntax

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), 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) 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<This> MediaOutputExt<This> for This
where This: MediaViewAlg + FormatViewAlg,

Source §

fn media_output_path( &self, media: &<This as MediaSorts>::Media, format: &<This as MediaSorts>::Format, target: &OutputTarget, ) -> PathBuf

Defines the final path one media item publishes its selected format at.

Source §

impl<This> MediaStreamsExt<This> for This
where This: FormatPredicateAlg,

Source §

fn stream_role_format( &self, streams: MediaStreams, ) -> <This as MediaSorts>::Predicate

Defines the predicate accepting exactly the formats those roles require.

Source §

impl<This> MetadataExt<This> for This
where This: MetadataAlg,

Source §

fn text_metadata( &self, key: impl Into<String>, value: impl Into<String>, ) -> <This as MediaSorts>::Metadata

Defines a record containing one textual field.

Source §

impl<This> ObservationLaws<This> for This
where This: MetadataAlg,

Source §

fn observation_laws(&self) -> Result<(), Error>
where <This as MediaSorts>::Metadata: PartialEq + Debug, <This as MediaSorts>::Value: Clone,

Checks that the empty record is neutral and later equal keys replace earlier ones.

§Errors

Returns the first violated law.

Source §

impl<This> OutputNameExt<This> for This
where This: OutputNameAlg,

Source §

fn portable_output_name( &self, title: Option<&str>, fallback: &str, extension: Option<&str>, ) -> <This as MediaSorts>::Output

Defines a portable file name from title, identity, and extension.

Source §

fn portable_user_output_name( &self, input: &str, fallback_extension: Option<&str>, ) -> <This as MediaSorts>::Output

Defines a portable edited file name.

Source §

impl<This> OutputNameLaws<This> for This
where This: OutputNameAlg,

Source §

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

Checks that naming is a function of its inputs and yields one safe file component.

§Errors

Returns the first violated law.

Source §

impl<This> RequestSelectionExt<This> for This
where This: FormatPredicateAlg + FormatSelectionAlg,

Source §

fn request_selection( &self, options: &impl RequestOptionsAlg, ) -> <This as MediaSorts>::Selection

Defines the selection one request’s own choices state.

Source §

impl<This> SelectionLaws<This> for This
where This: MetadataAlg + FormatAlg + FormatPredicateAlg + FormatSelectionAlg + FormatPredicateMatchAlg + FormatSelectionApplyAlg,

Source §

fn selection_laws(&self) -> Result<(), Error>
where <This as MediaSorts>::Predicate: Clone,

Checks best, worst, merge, and fallback against a catalog the scenario authors.

§Errors

Returns the first violated law.

Source §

fn check_selection_against( &self, catalog: &[<This as MediaSorts>::Format], predicate: &<This as MediaSorts>::Predicate, ) -> Result<(), Error>
where <This as MediaSorts>::Predicate: Clone,

Checks the selection laws for one catalog and predicate.

§Errors

Returns the first violated law.

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

Source §

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

Source §

impl<T, U> TryFrom 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 for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Source §

impl<This> YoutubeNotesExt<This> for This
where This: MetadataViewAlg,

Source §

fn granting_notes( &self, metadata: &<This as MediaSorts>::Metadata, ) -> Vec<String>

States what extraction observed about granting, in the words a reader reads.

A player response describes formats this interpreter may or may not be able to read: some state no location, some are held behind an unanswered signature, and some are served slowly on purpose. What is said here is what was counted, and nothing is said about a count the extractor did not state.

MediaSyntax

Struct MediaSyntax Copy item path

Trait Implementations§

impl ArtifactAlg for MediaSyntax

fn artifact( &self, id: impl Into<String>, kind: ArtifactKind, metadata: Self::Metadata, ) -> Self::Artifact

impl Clone for MediaSyntax

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl Copy for MediaSyntax

impl Debug for MediaSyntax

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

impl Default for MediaSyntax

fn default() -> Self

impl ExtractionAlg for MediaSyntax

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

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

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

impl ExtractionViewAlg for MediaSyntax

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

impl FormatAlg for MediaSyntax

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

impl FormatPredicateAlg for MediaSyntax

fn any_format(&self) -> Self::Predicate

fn format_id(&self, id: impl Into<String>) -> Self::Predicate

fn observed_format(&self, key: impl Into<String>) -> Self::Predicate

fn text_format( &self, key: impl Into<String>, value: impl Into<String>, ) -> Self::Predicate

fn flag_format(&self, key: impl Into<String>, value: bool) -> Self::Predicate

fn number_format( &self, key: impl Into<String>, comparison: FormatComparison, value: f64, ) -> Self::Predicate

fn all_formats( &self, left: Self::Predicate, right: Self::Predicate, ) -> Self::Predicate

fn not_format(&self, predicate: Self::Predicate) -> Self::Predicate

impl FormatPredicateMatchAlg for MediaSyntax

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

impl FormatSelectionAlg for MediaSyntax

fn best_format(&self, predicate: Self::Predicate) -> Self::Selection

fn worst_format(&self, predicate: Self::Predicate) -> Self::Selection

fn merge_formats( &self, selections: impl IntoIterator<Item = Self::Selection>, ) -> Self::Selection

fn fallback_formats( &self, selections: impl IntoIterator<Item = Self::Selection>, ) -> Self::Selection

impl FormatSelectionApplyAlg for MediaSyntax

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

impl FormatViewAlg for MediaSyntax

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

impl MediaSorts for MediaSyntax

type Value = InfoValue

type Metadata = InfoRecord

type Format = Format

type Artifact = Artifact

type Media = Media

type Extraction = Extraction

type Extractor = ExtractorKey

type Predicate = FormatPredicate

type Selection = FormatSelection

type Output = PathBuf

impl MediaViewAlg for MediaSyntax

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

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

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

impl MetadataAlg for MediaSyntax

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

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

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

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

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

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

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

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

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

impl MetadataViewAlg for MediaSyntax

fn metadata_text<'a>( &self, metadata: &'a InfoRecord, key: &str, ) -> Option<&'a str>

fn metadata_number(&self, metadata: &InfoRecord, key: &str) -> Option<i64>

impl OutputNameAlg for MediaSyntax

fn output_name(&self, component: String) -> Self::Output

Auto Trait Implementations§

impl Freeze for MediaSyntax

impl RefUnwindSafe for MediaSyntax

impl Send for MediaSyntax

impl Sync for MediaSyntax

impl Unpin for MediaSyntax

impl UnsafeUnpin for MediaSyntax

impl UnwindSafe for MediaSyntax

Blanket Implementations§

Struct MediaSyntax

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

impl<This> ArtifactLaws<This> for This
where This: MetadataAlg + ArtifactAlg,

fn artifact_laws(&self) -> Result<(), Error>
where <This as MediaSorts>::Artifact: PartialEq + Debug, <This as MediaSorts>::Metadata: Clone,

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

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

impl<T> CloneToUninit for T
where T: Clone,

impl<This> FormatLaws<This> for This
where This: MetadataAlg + FormatAlg + FormatViewAlg,

impl<This> FormatPredicateExt<This> for This
where This: FormatPredicateAlg,

impl<This, Predicate> FormatSelectionProgramExt<This, Predicate> for This
where This: FormatPredicateAlg<Predicate = Predicate, Predicate = Predicate> + FormatSelectionAlg,

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

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

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

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

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

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

impl<This> MediaOutputExt<This> for This
where This: MediaViewAlg + FormatViewAlg,

impl<This> MediaStreamsExt<This> for This
where This: FormatPredicateAlg,

impl<This> MetadataExt<This> for This
where This: MetadataAlg,

impl<This> ObservationLaws<This> for This
where This: MetadataAlg,

fn observation_laws(&self) -> Result<(), Error>
where <This as MediaSorts>::Metadata: PartialEq + Debug, <This as MediaSorts>::Value: Clone,

impl<This> OutputNameExt<This> for This
where This: OutputNameAlg,

impl<This> OutputNameLaws<This> for This
where This: OutputNameAlg,

impl<This> RequestSelectionExt<This> for This
where This: FormatPredicateAlg + FormatSelectionAlg,

impl<This> SelectionLaws<This> for This
where This: MetadataAlg + FormatAlg + FormatPredicateAlg + FormatSelectionAlg + FormatPredicateMatchAlg + FormatSelectionApplyAlg,

fn selection_laws(&self) -> Result<(), Error>
where <This as MediaSorts>::Predicate: Clone,