Struct gstreamer_base::Adapter [−][src]
pub struct Adapter(_);
This class is for elements that receive buffers in an undesired size. While for example raw video contains one image per buffer, the same is not true for a lot of other formats, especially those that come directly from a file. So if you have undefined buffer sizes and require a specific size, this object is for you.
An adapter is created with Self::new(). It can be freed again with
[crate::glib::object::ObjectExt::unref()].
The theory of operation is like this: All buffers received are put
into the adapter using Self::push() and the data is then read back
in chunks of the desired size using [Self::map()]/[Self::unmap()]
and/or Self::copy(). After the data has been processed, it is freed
using [Self::unmap()].
Other methods such as [Self::take()] and Self::take_buffer()
combine [Self::map()] and [Self::unmap()] in one method and are
potentially more convenient for some use cases.
For example, a sink pad’s chain function that needs to pass data to a library in 512-byte chunks could be implemented like this:
static GstFlowReturn
sink_pad_chain (GstPad *pad, GstObject *parent, GstBuffer *buffer)
{
MyElement *this;
GstAdapter *adapter;
GstFlowReturn ret = GST_FLOW_OK;
this = MY_ELEMENT (parent);
adapter = this->adapter;
// put buffer into adapter
gst_adapter_push (adapter, buffer);
// while we can read out 512 bytes, process them
while (gst_adapter_available (adapter) >= 512 && ret == GST_FLOW_OK) {
const guint8 *data = gst_adapter_map (adapter, 512);
// use flowreturn as an error value
ret = my_library_foo (data);
gst_adapter_unmap (adapter);
gst_adapter_flush (adapter, 512);
}
return ret;
}
For another example, a simple element inside GStreamer that uses crate::Adapter
is the libvisual element.
An element using crate::Adapter in its sink pad chain function should ensure that
when the FLUSH_STOP event is received, that any queued data is cleared using
Self::clear(). Data should also be cleared or processed on EOS and
when changing state from crate::gst::State::Paused to crate::gst::State::Ready.
Also check the GST_BUFFER_FLAG_DISCONT flag on the buffer. Some elements might need to clear the adapter after a discontinuity.
The adapter will keep track of the timestamps of the buffers
that were pushed. The last seen timestamp before the current position
can be queried with Self::prev_pts(). This function can
optionally return the number of bytes between the start of the buffer that
carried the timestamp and the current adapter position. The distance is
useful when dealing with, for example, raw audio samples because it allows
you to calculate the timestamp of the current adapter position by using the
last seen timestamp and the amount of bytes since. Additionally, the
Self::prev_pts_at_offset() can be used to determine the last
seen timestamp at a particular offset in the adapter.
The adapter will also keep track of the offset of the buffers
(GST_BUFFER_OFFSET) that were pushed. The last seen offset before the
current position can be queried with Self::prev_offset(). This function
can optionally return the number of bytes between the start of the buffer
that carried the offset and the current adapter position.
Additionally the adapter also keeps track of the PTS, DTS and buffer offset
at the last discontinuity, which can be retrieved with
Self::pts_at_discont(), Self::dts_at_discont() and
Self::offset_at_discont(). The number of bytes that were consumed
since then can be queried with Self::distance_from_discont().
A last thing to note is that while crate::Adapter is pretty optimized,
merging buffers still might be an operation that requires a malloc() and
memcpy() operation, and these operations are not the fastest. Because of
this, some functions like Self::available_fast() are provided to help
speed up such cases should you want to. To avoid repeated memory allocations,
Self::copy() can be used to copy data into a (statically allocated)
user provided buffer.
crate::Adapter is not MT safe. All operations on an adapter must be serialized by
the caller. This is not normally a problem, however, as the normal use case
of crate::Adapter is inside one pad’s chain function, in which case access is
serialized via the pad’s STREAM_LOCK.
Note that Self::push() takes ownership of the buffer passed. Use
gst_buffer_ref() before pushing it into the adapter if you still want to
access the buffer later. The adapter will never modify the data in the
buffer pushed in it.
Implements
Implementations
impl Adapter[src]
impl Adapter[src]pub fn new() -> Adapterⓘ[src]
pub fn new() -> Adapterⓘ[src]Creates a new crate::Adapter. Free with [crate::glib::object::ObjectExt::unref()].
Returns
a new crate::Adapter
pub fn available_fast(&self) -> usize[src]
pub fn available_fast(&self) -> usize[src]Gets the maximum number of bytes that are immediately available without requiring any expensive operations (like copying the data into a temporary buffer).
Returns
number of bytes that are available in self without expensive
operations
pub fn distance_from_discont(&self) -> u64[src]
This is supported on crate feature v1_10 only.
pub fn distance_from_discont(&self) -> u64[src]v1_10 only.Get the distance in bytes since the last buffer with the
[crate::gst::BufferFlags::Discont] flag.
The distance will be reset to 0 for all buffers with
[crate::gst::BufferFlags::Discont] on them, and then calculated for all other
following buffers based on their size.
Returns
The offset. Can be GST_BUFFER_OFFSET_NONE.
pub fn dts_at_discont(&self) -> ClockTime[src]
This is supported on crate feature v1_10 only.
pub fn dts_at_discont(&self) -> ClockTime[src]v1_10 only.Get the DTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.
Returns
The DTS at the last discont or GST_CLOCK_TIME_NONE.
pub fn offset_at_discont(&self) -> u64[src]
This is supported on crate feature v1_10 only.
pub fn offset_at_discont(&self) -> u64[src]v1_10 only.Get the offset that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_BUFFER_OFFSET_NONE.
Returns
The offset at the last discont or GST_BUFFER_OFFSET_NONE.
pub fn prev_dts(&self) -> (ClockTime, u64)[src]
pub fn prev_dts(&self) -> (ClockTime, u64)[src]Get the dts that was before the current byte in the adapter. When
distance is given, the amount of bytes between the dts and the current
position is returned.
The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a dts is removed from the adapter, the dts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
distance
pointer to location for distance, or None
Returns
The previously seen dts.
pub fn prev_dts_at_offset(&self, offset: usize) -> (ClockTime, u64)[src]
pub fn prev_dts_at_offset(&self, offset: usize) -> (ClockTime, u64)[src]Get the dts that was before the byte at offset offset in the adapter. When
distance is given, the amount of bytes between the dts and the current
position is returned.
The dts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a dts is removed from the adapter, the dts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
offset
the offset in the adapter at which to get timestamp
distance
pointer to location for distance, or None
Returns
The previously seen dts at given offset.
pub fn prev_offset(&self) -> (u64, u64)[src]
This is supported on crate feature v1_10 only.
pub fn prev_offset(&self) -> (u64, u64)[src]v1_10 only.Get the offset that was before the current byte in the adapter. When
distance is given, the amount of bytes between the offset and the current
position is returned.
The offset is reset to GST_BUFFER_OFFSET_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with an offset is removed from the adapter, the offset and distance returned are GST_BUFFER_OFFSET_NONE and 0 respectively.
distance
pointer to a location for distance, or None
Returns
The previous seen offset.
pub fn prev_pts(&self) -> (ClockTime, u64)[src]
pub fn prev_pts(&self) -> (ClockTime, u64)[src]Get the pts that was before the current byte in the adapter. When
distance is given, the amount of bytes between the pts and the current
position is returned.
The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a pts is removed from the adapter, the pts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
distance
pointer to location for distance, or None
Returns
The previously seen pts.
pub fn prev_pts_at_offset(&self, offset: usize) -> (ClockTime, u64)[src]
pub fn prev_pts_at_offset(&self, offset: usize) -> (ClockTime, u64)[src]Get the pts that was before the byte at offset offset in the adapter. When
distance is given, the amount of bytes between the pts and the current
position is returned.
The pts is reset to GST_CLOCK_TIME_NONE and the distance is set to 0 when the adapter is first created or when it is cleared. This also means that before the first byte with a pts is removed from the adapter, the pts and distance returned are GST_CLOCK_TIME_NONE and 0 respectively.
offset
the offset in the adapter at which to get timestamp
distance
pointer to location for distance, or None
Returns
The previously seen pts at given offset.
pub fn pts_at_discont(&self) -> ClockTime[src]
This is supported on crate feature v1_10 only.
pub fn pts_at_discont(&self) -> ClockTime[src]v1_10 only.Get the PTS that was on the last buffer with the GST_BUFFER_FLAG_DISCONT flag, or GST_CLOCK_TIME_NONE.
Returns
The PTS at the last discont or GST_CLOCK_TIME_NONE.
impl Adapter[src]
impl Adapter[src]pub fn copy(&self, offset: usize, dest: &mut [u8]) -> Result<(), BoolError>[src]
pub fn copy(&self, offset: usize, dest: &mut [u8]) -> Result<(), BoolError>[src]Copies size bytes of data starting at offset out of the buffers
contained in crate::Adapter into an array dest provided by the caller.
The array dest should be large enough to contain size bytes.
The user should check that the adapter has (offset + size) bytes
available before calling this function.
dest
the memory to copy into
offset
the bytes offset in the adapter to start from
size
the number of bytes to copy
pub fn copy_bytes(&self, offset: usize, size: usize) -> Result<Bytes, BoolError>[src]
pub fn copy_bytes(&self, offset: usize, size: usize) -> Result<Bytes, BoolError>[src]Similar to gst_adapter_copy, but more suitable for language bindings. size
bytes of data starting at offset will be copied out of the buffers contained
in self and into a new crate::glib::Bytes structure which is returned. Depending on
the value of the size argument an empty crate::glib::Bytes structure may be returned.
offset
the bytes offset in the adapter to start from
size
the number of bytes to copy
Returns
A new crate::glib::Bytes structure containing the copied data.
pub fn flush(&self, flush: usize)[src]
pub fn flush(&self, flush: usize)[src]Flushes the first flush bytes in the self. The caller must ensure that
at least this many bytes are available.
See also: [Self::map()], [Self::unmap()]
flush
the number of bytes to flush
pub fn buffer(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]
pub fn buffer_fast(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]
pub fn buffer_list(&self, nbytes: usize) -> Result<BufferList, BoolError>[src]
pub fn list(&self, nbytes: usize) -> Result<Vec<Buffer>, BoolError>[src]
pub fn masked_scan_uint32(
&self,
mask: u32,
pattern: u32,
offset: usize,
size: usize
) -> Result<Option<usize>, BoolError>[src]
pub fn masked_scan_uint32(
&self,
mask: u32,
pattern: u32,
offset: usize,
size: usize
) -> Result<Option<usize>, BoolError>[src]Scan for pattern pattern with applied mask mask in the adapter data,
starting from offset offset.
The bytes in pattern and mask are interpreted left-to-right, regardless
of endianness. All four bytes of the pattern must be present in the
adapter for it to match, even if the first or last bytes are masked out.
It is an error to call this function without making sure that there is enough data (offset+size bytes) in the adapter.
This function calls Self::masked_scan_uint32_peek() passing None
for value.
mask
mask to apply to data before matching against pattern
pattern
pattern to match (after mask is applied)
offset
offset into the adapter data from which to start scanning, returns the last scanned position.
size
number of bytes to scan from offset
Returns
offset of the first match, or -1 if no match was found.
Example:
// Assume the adapter contains 0x00 0x01 0x02 ... 0xfe 0xff
gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 0, 256);
// -> returns 0
gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x00010203, 1, 255);
// -> returns -1
gst_adapter_masked_scan_uint32 (adapter, 0xffffffff, 0x01020304, 1, 255);
// -> returns 1
gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0001, 0, 256);
// -> returns -1
gst_adapter_masked_scan_uint32 (adapter, 0xffff, 0x0203, 0, 256);
// -> returns 0
gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 256);
// -> returns 2
gst_adapter_masked_scan_uint32 (adapter, 0xffff0000, 0x02030000, 0, 4);
// -> returns -1
pub fn masked_scan_uint32_peek(
&self,
mask: u32,
pattern: u32,
offset: usize,
size: usize
) -> Result<Option<(usize, u32)>, BoolError>[src]
pub fn masked_scan_uint32_peek(
&self,
mask: u32,
pattern: u32,
offset: usize,
size: usize
) -> Result<Option<(usize, u32)>, BoolError>[src]Scan for pattern pattern with applied mask mask in the adapter data,
starting from offset offset. If a match is found, the value that matched
is returned through value, otherwise value is left untouched.
The bytes in pattern and mask are interpreted left-to-right, regardless
of endianness. All four bytes of the pattern must be present in the
adapter for it to match, even if the first or last bytes are masked out.
It is an error to call this function without making sure that there is enough data (offset+size bytes) in the adapter.
mask
mask to apply to data before matching against pattern
pattern
pattern to match (after mask is applied)
offset
offset into the adapter data from which to start scanning, returns the last scanned position.
size
number of bytes to scan from offset
value
pointer to uint32 to return matching data
Returns
offset of the first match, or -1 if no match was found.
pub fn take_buffer(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]
pub fn take_buffer(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]Returns a crate::gst::Buffer containing the first nbytes bytes of the
self. The returned bytes will be flushed from the adapter.
This function is potentially more performant than
[Self::take()] since it can reuse the memory in pushed buffers
by subbuffering or merging. This function will always return a
buffer with a single memory region.
Note that no assumptions should be made as to whether certain buffer flags such as the DISCONT flag are set on the returned buffer, or not. The caller needs to explicitly set or unset flags that should be set or unset.
Since 1.6 this will also copy over all GstMeta of the input buffers except
for meta with the [crate::gst::MetaFlags::Pooled] flag or with the “memory” tag.
Caller owns a reference to the returned buffer. gst_buffer_unref() after
usage.
Free-function: gst_buffer_unref
nbytes
the number of bytes to take
Returns
a crate::gst::Buffer containing the first
nbytes of the adapter, or None if nbytes bytes are not available.
gst_buffer_unref() when no longer needed.
pub fn take_buffer_fast(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]
pub fn take_buffer_fast(&self, nbytes: usize) -> Result<Buffer, BoolError>[src]Returns a crate::gst::Buffer containing the first nbytes of the self.
The returned bytes will be flushed from the adapter. This function
is potentially more performant than Self::take_buffer() since
it can reuse the memory in pushed buffers by subbuffering or
merging. Unlike Self::take_buffer(), the returned buffer may
be composed of multiple non-contiguous crate::gst::Memory objects, no
copies are made.
Note that no assumptions should be made as to whether certain buffer flags such as the DISCONT flag are set on the returned buffer, or not. The caller needs to explicitly set or unset flags that should be set or unset.
This will also copy over all GstMeta of the input buffers except
for meta with the [crate::gst::MetaFlags::Pooled] flag or with the “memory” tag.
This function can return buffer up to the return value of
Self::available() without making copies if possible.
Caller owns a reference to the returned buffer. gst_buffer_unref() after
usage.
Free-function: gst_buffer_unref
nbytes
the number of bytes to take
Returns
a crate::gst::Buffer containing the first
nbytes of the adapter, or None if nbytes bytes are not available.
gst_buffer_unref() when no longer needed.
pub fn take_buffer_list(&self, nbytes: usize) -> Result<BufferList, BoolError>[src]
pub fn take_buffer_list(&self, nbytes: usize) -> Result<BufferList, BoolError>[src]Returns a crate::gst::BufferList of buffers containing the first nbytes bytes of
the self. The returned bytes will be flushed from the adapter.
When the caller can deal with individual buffers, this function is more
performant because no memory should be copied.
Caller owns the returned list. Call gst_buffer_list_unref() to free
the list after usage.
nbytes
the number of bytes to take
Returns
a crate::gst::BufferList of buffers containing
the first nbytes of the adapter, or None if nbytes bytes are not
available
pub fn take_list(&self, nbytes: usize) -> Result<Vec<Buffer>, BoolError>[src]
pub fn take_list(&self, nbytes: usize) -> Result<Vec<Buffer>, BoolError>[src]Returns a [crate::glib::List] of buffers containing the first nbytes bytes of the
self. The returned bytes will be flushed from the adapter.
When the caller can deal with individual buffers, this function is more
performant because no memory should be copied.
Caller owns returned list and contained buffers. gst_buffer_unref() each
buffer in the list before freeing the list after usage.
nbytes
the number of bytes to take
Returns
a [crate::glib::List] of
buffers containing the first nbytes of the adapter, or None if nbytes
bytes are not available
pub fn push(&self, buf: Buffer)[src]
pub fn push(&self, buf: Buffer)[src]Adds the data from buf to the data stored inside self and takes
ownership of the buffer.
buf
a crate::gst::Buffer to add to queue in the adapter
Trait Implementations
impl Ord for Adapter[src]
impl Ord for Adapter[src]impl ParentClassIs for Adapter[src]
impl ParentClassIs for Adapter[src]impl<T: ObjectType> PartialEq<T> for Adapter[src]
impl<T: ObjectType> PartialEq<T> for Adapter[src]impl<T: ObjectType> PartialOrd<T> for Adapter[src]
impl<T: ObjectType> PartialOrd<T> for Adapter[src]fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]This method returns an ordering between self and other values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
impl Read for Adapter[src]
impl Read for Adapter[src]fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>[src]Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>1.36.0[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>1.36.0[src]Like read, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool[src]
fn is_read_vectored(&self) -> bool[src]can_vector)Determines if this Reader has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer[src]
unsafe fn initializer(&self) -> Initializer[src]read_initializer)Determines if this Reader can work with buffers of uninitialized
memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>1.0.0[src]Read all bytes until EOF in this source, placing them into buf. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>1.0.0[src]Read all bytes until EOF in this source, appending them to buf. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>1.6.0[src]Read the exact number of bytes required to fill buf. Read more
fn by_ref(&mut self) -> &mut Self1.0.0[src]
fn by_ref(&mut self) -> &mut Self1.0.0[src]Creates a “by reference” adaptor for this instance of Read. Read more
impl StaticType for Adapter[src]
impl StaticType for Adapter[src]fn static_type() -> Type[src]
fn static_type() -> Type[src]Returns the type identifier of Self.
impl Eq for Adapter[src]
impl StructuralEq for Adapter[src]
Auto Trait Implementations
impl RefUnwindSafe for Adapter
impl !Send for Adapter
impl !Sync for Adapter
impl Unpin for Adapter
impl UnwindSafe for Adapter
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]
pub fn borrow_mut(&mut self) -> &mut T[src]Mutably borrows from an owned value. Read more
impl<T> Cast for T where
T: ObjectType, [src]
impl<T> Cast for T where
T: ObjectType, [src]fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a superclass or interface T. Read more
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a reference of its superclass or interface T. Read more
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a subclass or interface implementor T. Read more
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a reference of its subclass or interface implementor T. Read more
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]Tries to cast to reference to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]Casts to T unconditionally. Read more
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]Casts to &T unconditionally. Read more
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]pub fn set_property_from_str(&self, name: &str, value: &str)[src]
impl<T> ObjectExt for T where
T: ObjectType, [src]
impl<T> ObjectExt for T where
T: ObjectType, [src]pub fn is<U>(&self) -> bool where
U: StaticType, [src]
pub fn is<U>(&self) -> bool where
U: StaticType, [src]Returns true if the object is an instance of (can be cast to) T.
pub fn type_(&self) -> Type[src]
pub fn object_class(&self) -> &Class<Object>[src]
pub fn class(&self) -> &Class<T> where
T: IsClass, [src]
T: IsClass,
pub fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass, [src]
U: IsClass,
pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface, [src]
U: IsInterface,
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, [src]
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, [src]
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub fn block_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn unblock_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn stop_signal_emission(&self, signal_name: &str)[src]
pub fn disconnect(&self, handler_id: SignalHandlerId)[src]
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, [src]
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn notify_by_pspec(&self, pspec: &ParamSpec)[src]
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn list_properties(&self) -> Vec<ParamSpec, Global>[src]
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]Same as connect_unsafe but takes a SignalId instead of a signal name.
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal by signal id.
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal with details by signal id.
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]Emit signal by it’s name.
pub fn downgrade(&self) -> WeakRef<T>[src]
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>, [src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
pub fn ref_count(&self) -> u32[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]Same as emit but takes Value for the arguments.
impl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone, [src]type Owned = T
type Owned = TThe resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn to_owned(&self) -> T[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)[src]
pub fn clone_into(&self, target: &mut T)[src]🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]pub fn to_send_value(&self) -> SendValue[src]
pub fn to_send_value(&self) -> SendValue[src]Returns a SendValue clone of self.
impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>, [src]
Sub: IsA<Super>,
Super: IsA<Super>,
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>, [src]
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,