gstreamer-rs/gstreamer/src/stream_collection.rs
Marijn Suijten 540062b97c Add missing doc aliases to manual code
Using the same script as [1], called with:

    python3 add_doc_alias.py gstreamer*/**/src

[1]: https://github.com/gtk-rs/gtk-rs-core/pull/83
2021-05-19 22:36:18 +02:00

151 lines
3.6 KiB
Rust

// Take a look at the license at the top of the repository in the LICENSE file.
use crate::Stream;
use crate::StreamCollection;
use glib::translate::*;
use std::fmt;
#[derive(Debug)]
pub struct Iter<'a> {
collection: &'a StreamCollection,
idx: u32,
size: u32,
}
impl<'a> Iter<'a> {
fn new(collection: &'a StreamCollection) -> Iter<'a> {
skip_assert_initialized!();
Iter {
collection,
idx: 0,
size: collection.len() as u32,
}
}
}
impl<'a> Iterator for Iter<'a> {
type Item = Stream;
fn next(&mut self) -> Option<Self::Item> {
if self.idx >= self.size {
return None;
}
let item = self.collection.stream(self.idx);
self.idx += 1;
item
}
fn size_hint(&self) -> (usize, Option<usize>) {
if self.idx == self.size {
return (0, Some(0));
}
let remaining = (self.size - self.idx) as usize;
(remaining, Some(remaining))
}
}
impl<'a> DoubleEndedIterator for Iter<'a> {
fn next_back(&mut self) -> Option<Self::Item> {
if self.idx == self.size {
return None;
}
self.size -= 1;
self.collection.stream(self.size)
}
}
impl<'a> ExactSizeIterator for Iter<'a> {}
#[derive(Debug, Clone)]
pub struct StreamCollectionBuilder(StreamCollection);
impl StreamCollectionBuilder {
#[doc(alias = "gst_stream_collection_add_stream")]
pub fn stream(self, stream: &Stream) -> Self {
unsafe {
ffi::gst_stream_collection_add_stream((self.0).to_glib_none().0, stream.to_glib_full());
}
self
}
pub fn streams<S: AsRef<Stream>>(self, streams: &[S]) -> Self {
for stream in streams {
unsafe {
ffi::gst_stream_collection_add_stream(
(self.0).to_glib_none().0,
stream.as_ref().to_glib_full(),
);
}
}
self
}
pub fn build(self) -> StreamCollection {
self.0
}
}
impl StreamCollection {
pub fn builder(upstream_id: Option<&str>) -> StreamCollectionBuilder {
assert_initialized_main_thread!();
let upstream_id = upstream_id.to_glib_none();
let (major, minor, _, _) = crate::version();
let collection = if (major, minor) > (1, 12) {
unsafe { from_glib_full(ffi::gst_stream_collection_new(upstream_id.0)) }
} else {
// Work-around for 1.14 switching from transfer-floating to transfer-full
unsafe { from_glib_none(ffi::gst_stream_collection_new(upstream_id.0)) }
};
StreamCollectionBuilder(collection)
}
pub fn iter(&self) -> Iter {
Iter::new(self)
}
pub fn len(&self) -> usize {
self.size() as usize
}
pub fn is_empty(&self) -> bool {
self.len() == 0
}
pub fn debug(&self) -> Debug {
Debug(self)
}
}
pub struct Debug<'a>(&'a StreamCollection);
impl<'a> fmt::Debug for Debug<'a> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
struct Streams<'a>(&'a StreamCollection);
impl<'a> fmt::Debug for Streams<'a> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let mut f = f.debug_list();
for stream in self.0.iter() {
f.entry(&stream.debug());
}
f.finish()
}
}
let streams = Streams(self.0);
f.debug_struct("StreamCollection")
.field("streams", &streams)
.finish()
}
}