Generate missing doc aliases for newtypes

This commit is contained in:
Guillaume Gomez 2021-06-01 15:15:59 +02:00
parent 04e6c1b547
commit 5ba79976a9
39 changed files with 59 additions and 0 deletions

View file

@ -40,6 +40,7 @@ impl IntoGlib for AudioEndianness {
}
}
#[doc(alias = "GstAudioFormatInfo")]
pub struct AudioFormatInfo(&'static ffi::GstAudioFormatInfo);
impl AudioFormatInfo {

View file

@ -9,6 +9,7 @@ use std::fmt;
use std::mem;
use std::ptr;
#[doc(alias = "GstAudioInfo")]
pub struct AudioInfo(ffi::GstAudioInfo, [crate::AudioChannelPosition; 64]);
impl fmt::Debug for AudioInfo {

View file

@ -15,6 +15,7 @@ use glib::translate::{from_glib_none, ToGlibPtr};
use gst::prelude::*;
#[repr(transparent)]
#[doc(alias = "GstAudioClippingMeta")]
pub struct AudioClippingMeta(ffi::GstAudioClippingMeta);
unsafe impl Send for AudioClippingMeta {}
@ -75,6 +76,7 @@ impl fmt::Debug for AudioClippingMeta {
#[cfg(any(feature = "v1_16", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_16")))]
#[repr(transparent)]
#[doc(alias = "GstAudioMeta")]
pub struct AudioMeta(ffi::GstAudioMeta);
#[cfg(any(feature = "v1_16", feature = "dox"))]

View file

@ -5,6 +5,7 @@ use glib::translate::*;
glib::wrapper! {
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstFlowCombiner")]
pub struct FlowCombiner(Shared<ffi::GstFlowCombiner>);
match fn {

View file

@ -3,6 +3,7 @@
use glib::translate::mut_override;
#[must_use = "if unused the Mutex will immediately unlock"]
#[doc(alias = "GMutex")]
pub struct MutexGuard<'a>(&'a glib::ffi::GMutex);
impl<'a> MutexGuard<'a> {

View file

@ -10,6 +10,7 @@ use std::path;
use std::ptr;
#[derive(Debug)]
#[doc(alias = "GstHarness")]
pub struct Harness(ptr::NonNull<ffi::GstHarness>);
impl Drop for Harness {

View file

@ -4,6 +4,7 @@ use glib::translate::*;
glib::wrapper! {
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstControlPoint")]
pub struct ControlPoint(Boxed<ffi::GstControlPoint>);
match fn {

View file

@ -8,6 +8,7 @@ use gst::prelude::*;
use crate::GLContext;
#[repr(transparent)]
#[doc(alias = "GstGLSyncMeta")]
pub struct GLSyncMeta(ffi::GstGLSyncMeta);
unsafe impl Send for GLSyncMeta {}

View file

@ -6,6 +6,7 @@ use glib::translate::*;
use gst::prelude::*;
#[repr(transparent)]
#[doc(alias = "GstNetAddressMeta")]
pub struct NetAddressMeta(ffi::GstNetAddressMeta);
unsafe impl Send for NetAddressMeta {}

View file

@ -4,6 +4,7 @@ use glib::translate::*;
use std::ptr;
#[derive(Debug, PartialEq, Eq)]
#[doc(alias = "GstRTSPContext")]
pub struct RTSPContext(ptr::NonNull<ffi::GstRTSPContext>);
impl RTSPContext {

View file

@ -7,6 +7,7 @@ use std::mem;
use glib::translate::*;
#[repr(transparent)]
#[doc(alias = "GstSDPAttribute")]
pub struct SDPAttribute(pub(crate) ffi::GstSDPAttribute);
unsafe impl Send for SDPAttribute {}

View file

@ -7,6 +7,7 @@ use std::mem;
use glib::translate::*;
#[repr(transparent)]
#[doc(alias = "GstSDPBandwidth")]
pub struct SDPBandwidth(pub(crate) ffi::GstSDPBandwidth);
unsafe impl Send for SDPBandwidth {}

View file

@ -7,6 +7,7 @@ use std::mem;
use glib::translate::*;
#[repr(transparent)]
#[doc(alias = "GstSDPConnection")]
pub struct SDPConnection(pub(crate) ffi::GstSDPConnection);
unsafe impl Send for SDPConnection {}

View file

@ -4,6 +4,7 @@ use std::ffi::CStr;
use std::fmt;
#[repr(transparent)]
#[doc(alias = "GstSDPKey")]
pub struct SDPKey(ffi::GstSDPKey);
unsafe impl Send for SDPKey {}

View file

@ -16,6 +16,7 @@ use crate::sdp_key::SDPKey;
glib::wrapper! {
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstSDPMedia")]
pub struct SDPMedia(Boxed<ffi::GstSDPMedia>);
match fn {
@ -78,6 +79,7 @@ impl fmt::Display for SDPMedia {
}
#[repr(transparent)]
#[doc(alias = "GstSDPMedia")]
pub struct SDPMediaRef(ffi::GstSDPMedia);
impl fmt::Debug for SDPMediaRef {

View file

@ -22,6 +22,7 @@ use crate::sdp_zone::SDPZone;
glib::wrapper! {
#[derive(PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstSDPMessage")]
pub struct SDPMessage(Boxed<ffi::GstSDPMessage>);
match fn {
@ -118,6 +119,7 @@ impl SDPMessage {
}
#[repr(transparent)]
#[doc(alias = "GstSDPMessage")]
pub struct SDPMessageRef(ffi::GstSDPMessage);
impl fmt::Debug for SDPMessageRef {

View file

@ -4,6 +4,7 @@ use std::ffi::CStr;
use std::fmt;
#[repr(transparent)]
#[doc(alias = "GstSDPOrigin")]
pub struct SDPOrigin(pub(crate) ffi::GstSDPOrigin);
unsafe impl Send for SDPOrigin {}

View file

@ -9,6 +9,7 @@ use std::ptr;
use glib::translate::*;
#[repr(transparent)]
#[doc(alias = "GstSDPTime")]
pub struct SDPTime(pub(crate) ffi::GstSDPTime);
unsafe impl Send for SDPTime {}

View file

@ -7,6 +7,7 @@ use std::mem;
use glib::translate::*;
#[repr(transparent)]
#[doc(alias = "GstSDPZone")]
pub struct SDPZone(pub(crate) ffi::GstSDPZone);
unsafe impl Send for SDPZone {}

View file

@ -31,6 +31,7 @@ pub static BUFFER_POOL_OPTION_VIDEO_META: Lazy<&'static str> = Lazy::new(|| unsa
});
#[derive(Debug, Clone)]
#[doc(alias = "GstVideoAlignment")]
pub struct VideoAlignment(pub(crate) ffi::GstVideoAlignment);
impl VideoAlignment {

View file

@ -7,6 +7,7 @@ use std::ops;
use std::ptr;
#[derive(Debug)]
#[doc(alias = "GstVideoConverter")]
pub struct VideoConverter(ptr::NonNull<ffi::GstVideoConverter>);
impl Drop for VideoConverter {

View file

@ -7,6 +7,7 @@ use std::str;
use glib::translate::{from_glib, IntoGlib, ToGlibPtr};
#[doc(alias = "GstVideoFormatInfo")]
pub struct VideoFormatInfo(&'static ffi::GstVideoFormatInfo);
impl VideoFormatInfo {

View file

@ -82,6 +82,7 @@ impl ToValue for VideoColorRange {
}
}
#[doc(alias = "GstVideoColorimetry")]
pub struct VideoColorimetry(ffi::GstVideoColorimetry);
impl VideoColorimetry {
@ -248,6 +249,7 @@ impl std::convert::TryFrom<crate::VideoMultiviewMode> for crate::VideoMultiviewF
}
}
#[doc(alias = "GstVideoInfo")]
pub struct VideoInfo(pub(crate) ffi::GstVideoInfo);
impl fmt::Debug for VideoInfo {

View file

@ -7,6 +7,7 @@ use glib::translate::{from_glib, from_glib_none, FromGlib, IntoGlib, ToGlibPtr};
use gst::prelude::*;
#[repr(transparent)]
#[doc(alias = "GstVideoMeta")]
pub struct VideoMeta(ffi::GstVideoMeta);
unsafe impl Send for VideoMeta {}
@ -245,6 +246,7 @@ impl fmt::Debug for VideoMeta {
}
#[repr(transparent)]
#[doc(alias = "GstVideoCropMeta")]
pub struct VideoCropMeta(ffi::GstVideoCropMeta);
unsafe impl Send for VideoCropMeta {}
@ -307,6 +309,7 @@ impl fmt::Debug for VideoCropMeta {
}
#[repr(transparent)]
#[doc(alias = "GstVideoRegionOfInterestMeta")]
pub struct VideoRegionOfInterestMeta(ffi::GstVideoRegionOfInterestMeta);
unsafe impl Send for VideoRegionOfInterestMeta {}
@ -448,6 +451,7 @@ impl fmt::Debug for VideoRegionOfInterestMeta {
}
#[repr(transparent)]
#[doc(alias = "GstVideoAffineTransformationMeta")]
pub struct VideoAffineTransformationMeta(ffi::GstVideoAffineTransformationMeta);
unsafe impl Send for VideoAffineTransformationMeta {}
@ -511,6 +515,7 @@ impl fmt::Debug for VideoAffineTransformationMeta {
}
#[repr(transparent)]
#[doc(alias = "GstVideoOverlayCompositionMeta")]
pub struct VideoOverlayCompositionMeta(ffi::GstVideoOverlayCompositionMeta);
unsafe impl Send for VideoOverlayCompositionMeta {}
@ -573,6 +578,7 @@ impl fmt::Debug for VideoOverlayCompositionMeta {
#[cfg(any(feature = "v1_16", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_16")))]
#[repr(transparent)]
#[doc(alias = "GstVideoCaptionMeta")]
pub struct VideoCaptionMeta(ffi::GstVideoCaptionMeta);
#[cfg(any(feature = "v1_16", feature = "dox"))]
@ -645,6 +651,7 @@ impl fmt::Debug for VideoCaptionMeta {
#[cfg(any(feature = "v1_18", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
#[repr(transparent)]
#[doc(alias = "GstVideoAFDMeta")]
pub struct VideoAFDMeta(ffi::GstVideoAFDMeta);
#[cfg(any(feature = "v1_18", feature = "dox"))]
@ -720,6 +727,7 @@ impl fmt::Debug for VideoAFDMeta {
#[cfg(any(feature = "v1_18", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_18")))]
#[repr(transparent)]
#[doc(alias = "GstVideoBarMeta")]
pub struct VideoBarMeta(ffi::GstVideoBarMeta);
#[cfg(any(feature = "v1_18", feature = "dox"))]

View file

@ -16,7 +16,9 @@ use crate::VideoTimeCodeFlags;
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_12")))]
use crate::VideoTimeCodeInterval;
#[doc(alias = "GstVideoTimeCode")]
pub struct VideoTimeCode(ffi::GstVideoTimeCode);
#[doc(alias = "GstVideoTimeCode")]
pub struct ValidVideoTimeCode(ffi::GstVideoTimeCode);
impl VideoTimeCode {
@ -541,6 +543,7 @@ impl From<ValidVideoTimeCode> for VideoTimeCode {
}
#[repr(transparent)]
#[doc(alias = "GstVideoTimeCodeMeta")]
pub struct VideoTimeCodeMeta(ffi::GstVideoTimeCodeMeta);
unsafe impl Send for VideoTimeCodeMeta {}

View file

@ -9,6 +9,7 @@ use std::ptr;
use std::str;
#[derive(Clone)]
#[doc(alias = "GstVideoTimeCodeInterval")]
pub struct VideoTimeCodeInterval(ffi::GstVideoTimeCodeInterval);
impl VideoTimeCodeInterval {

View file

@ -7,6 +7,7 @@ use glib::translate::*;
use crate::MemoryFlags;
#[derive(Debug, Clone)]
#[doc(alias = "GstAllocationParams")]
pub struct AllocationParams(ffi::GstAllocationParams);
unsafe impl Send for AllocationParams {}

View file

@ -187,6 +187,7 @@ impl BufferPoolConfig {
}
#[derive(Debug)]
#[doc(alias = "GstBufferPoolAcquireParams")]
pub struct BufferPoolAcquireParams(ffi::GstBufferPoolAcquireParams);
unsafe impl Send for BufferPoolAcquireParams {}

View file

@ -13,6 +13,7 @@ use once_cell::sync::Lazy;
use glib::translate::*;
use glib::StaticType;
#[doc(alias = "GstCapsFeatures")]
pub struct CapsFeatures(ptr::NonNull<ffi::GstCapsFeatures>);
unsafe impl Send for CapsFeatures {}
unsafe impl Sync for CapsFeatures {}
@ -278,6 +279,7 @@ impl GlibPtrDefault for CapsFeatures {
}
#[repr(transparent)]
#[doc(alias = "GstCapsFeatures")]
pub struct CapsFeaturesRef(ffi::GstCapsFeatures);
impl CapsFeaturesRef {

View file

@ -15,6 +15,7 @@ use glib::prelude::*;
use glib::translate::*;
#[derive(PartialEq, Eq)]
#[doc(alias = "GstDebugMessage")]
pub struct DebugMessage(ptr::NonNull<ffi::GstDebugMessage>);
impl fmt::Debug for DebugMessage {
@ -39,6 +40,7 @@ impl DebugMessage {
}
#[derive(PartialEq, Eq, Clone, Copy)]
#[doc(alias = "GstDebugCategory")]
pub struct DebugCategory(Option<ptr::NonNull<ffi::GstDebugCategory>>);
impl DebugCategory {
@ -389,6 +391,7 @@ unsafe impl Send for DebugLogFunction {}
unsafe impl Sync for DebugLogFunction {}
#[derive(Debug)]
#[doc(alias = "GObject")]
pub struct LoggedObject(ptr::NonNull<glib::gobject_ffi::GObject>);
impl LoggedObject {

View file

@ -234,6 +234,7 @@ impl<'a, U> MetaRefMut<'a, Meta, U> {
}
#[repr(transparent)]
#[doc(alias = "GstMeta")]
pub struct Meta(ffi::GstMeta);
unsafe impl Send for Meta {}
@ -261,6 +262,7 @@ impl fmt::Debug for Meta {
}
#[repr(transparent)]
#[doc(alias = "GstParentBufferMeta")]
pub struct ParentBufferMeta(ffi::GstParentBufferMeta);
unsafe impl Send for ParentBufferMeta {}
@ -309,6 +311,7 @@ impl fmt::Debug for ParentBufferMeta {
}
#[repr(transparent)]
#[doc(alias = "GstProtectionMeta")]
pub struct ProtectionMeta(ffi::GstProtectionMeta);
unsafe impl Send for ProtectionMeta {}
@ -356,6 +359,7 @@ impl fmt::Debug for ProtectionMeta {
#[cfg(any(feature = "v1_14", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_14")))]
#[repr(transparent)]
#[doc(alias = "GstReferenceTimestampMeta")]
pub struct ReferenceTimestampMeta(ffi::GstReferenceTimestampMeta);
#[cfg(any(feature = "v1_14", feature = "dox"))]

View file

@ -4,6 +4,7 @@ use glib::translate::*;
glib::wrapper! {
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstParseContext")]
pub struct ParseContext(Boxed<ffi::GstParseContext>);
match fn {

View file

@ -11,6 +11,7 @@ use std::{ops::Deref, pin::Pin};
glib::wrapper! {
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[doc(alias = "GstPromise")]
pub struct Promise(Shared<ffi::GstPromise>);
match fn {

View file

@ -14,6 +14,7 @@ use std::ptr;
pub type Segment = FormattedSegment<GenericFormattedValue>;
#[repr(transparent)]
#[doc(alias = "GstSegment")]
pub struct FormattedSegment<T: FormattedValue>(ffi::GstSegment, PhantomData<T>);
impl Segment {

View file

@ -9,6 +9,7 @@ use std::ffi::CStr;
use std::fmt;
use std::ptr;
#[doc(alias = "GstStaticCaps")]
pub struct StaticCaps(ptr::NonNull<ffi::GstStaticCaps>);
impl StaticCaps {

View file

@ -10,6 +10,7 @@ use std::ffi::CStr;
use std::fmt;
use std::ptr;
#[doc(alias = "GstStaticPadTemplate")]
pub struct StaticPadTemplate(ptr::NonNull<ffi::GstStaticPadTemplate>);
impl StaticPadTemplate {

View file

@ -62,6 +62,7 @@ impl GlibValueError for glib::value::ValueTypeMismatchOrNoneError {
}
}
#[doc(alias = "GstStructure")]
pub struct Structure(ptr::NonNull<ffi::GstStructure>);
unsafe impl Send for Structure {}
unsafe impl Sync for Structure {}
@ -354,6 +355,7 @@ impl GlibPtrDefault for Structure {
}
#[repr(transparent)]
#[doc(alias = "GstStructure")]
pub struct StructureRef(ffi::GstStructure);
unsafe impl Send for StructureRef {}

View file

@ -12,6 +12,7 @@ use std::slice;
#[repr(transparent)]
#[derive(Debug)]
#[doc(alias = "GstTypeFind")]
pub struct TypeFind(ffi::GstTypeFind);
pub trait TypeFindImpl {

View file

@ -3,6 +3,7 @@
use glib::translate::mut_override;
#[must_use = "if unused the Mutex will immediately unlock"]
#[doc(alias = "GMutex")]
pub struct MutexGuard<'a>(&'a glib::ffi::GMutex);
impl<'a> MutexGuard<'a> {