Struct gstreamer_base::BaseSink[][src]

pub struct BaseSink(_);

crate::BaseSink is the base class for sink elements in GStreamer, such as xvimagesink or filesink. It is a layer on top of crate::gst::Element that provides a simplified interface to plugin writers. crate::BaseSink handles many details for you, for example: preroll, clock synchronization, state changes, activation in push or pull mode, and queries.

In most cases, when writing sink elements, there is no need to implement class methods from crate::gst::Element or to set functions on pads, because the crate::BaseSink infrastructure should be sufficient.

crate::BaseSink provides support for exactly one sink pad, which should be named “sink”. A sink implementation (subclass of crate::BaseSink) should install a pad template in its class_init function, like so:

static void
my_element_class_init (GstMyElementClass *klass)
{
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

  // sinktemplate should be a #GstStaticPadTemplate with direction
  // %GST_PAD_SINK and name "sink"
  gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);

  gst_element_class_set_static_metadata (gstelement_class,
      "Sink name",
      "Sink",
      "My Sink element",
      "The author <my.sink@my.email>");
}

crate::BaseSink will handle the prerolling correctly. This means that it will return crate::gst::StateChangeReturn::Async from a state change to PAUSED until the first buffer arrives in this element. The base class will call the [crate::GstBaseSinkClass.preroll()] vmethod with this preroll buffer and will then commit the state change to the next asynchronously pending state.

When the element is set to PLAYING, crate::BaseSink will synchronise on the clock using the times returned from [crate::GstBaseSinkClass.get_times()]. If this function returns GST_CLOCK_TIME_NONE for the start time, no synchronisation will be done. Synchronisation can be disabled entirely by setting the object [crate::BaseSink:sync] property to false.

After synchronisation the virtual method [crate::GstBaseSinkClass.render()] will be called. Subclasses should minimally implement this method.

Subclasses that synchronise on the clock in the [crate::GstBaseSinkClass.render()] method are supported as well. These classes typically receive a buffer in the render method and can then potentially block on the clock while rendering. A typical example is an audiosink. These subclasses can use crate::prelude::BaseSinkExt::wait_preroll() to perform the blocking wait.

Upon receiving the EOS event in the PLAYING state, crate::BaseSink will wait for the clock to reach the time indicated by the stop time of the last [crate::GstBaseSinkClass.get_times()] call before posting an EOS message. When the element receives EOS in PAUSED, preroll completes, the event is queued and an EOS message is posted when going to PLAYING.

crate::BaseSink will internally use the crate::gst::EventType::Segment events to schedule synchronisation and clipping of buffers. Buffers that fall completely outside of the current segment are dropped. Buffers that fall partially in the segment are rendered (and prerolled). Subclasses should do any subbuffer clipping themselves when needed.

crate::BaseSink will by default report the current playback position in crate::gst::Format::Time based on the current clock time and segment information. If no clock has been set on the element, the query will be forwarded upstream.

The [crate::GstBaseSinkClass.set_caps()] function will be called when the subclass should configure itself to process a specific media type.

The [crate::GstBaseSinkClass.start()] and [crate::GstBaseSinkClass.stop()] virtual methods will be called when resources should be allocated. Any [crate::GstBaseSinkClass.preroll()], [crate::GstBaseSinkClass.render()] and [crate::GstBaseSinkClass.set_caps()] function will be called between the [crate::GstBaseSinkClass.start()] and [crate::GstBaseSinkClass.stop()] calls.

The [crate::GstBaseSinkClass.event()] virtual method will be called when an event is received by crate::BaseSink. Normally this method should only be overridden by very specific elements (such as file sinks) which need to handle the newsegment event specially.

The [crate::GstBaseSinkClass.unlock()] method is called when the elements should unblock any blocking operations they perform in the [crate::GstBaseSinkClass.render()] method. This is mostly useful when the [crate::GstBaseSinkClass.render()] method performs a blocking write on a file descriptor, for example.

The [crate::BaseSink:max-lateness] property affects how the sink deals with buffers that arrive too late in the sink. A buffer arrives too late in the sink when the presentation time (as a combination of the last segment, buffer timestamp and element base_time) plus the duration is before the current time of the clock. If the frame is later than max-lateness, the sink will drop the buffer without calling the render method. This feature is disabled if sync is disabled, the [crate::GstBaseSinkClass.get_times()] method does not return a valid start time or max-lateness is set to -1 (the default). Subclasses can use crate::prelude::BaseSinkExt::set_max_lateness() to configure the max-lateness value.

The [crate::BaseSink:qos] property will enable the quality-of-service features of the basesink which gather statistics about the real-time performance of the clock synchronisation. For each buffer received in the sink, statistics are gathered and a QOS event is sent upstream with these numbers. This information can then be used by upstream elements to reduce their processing rate, for example.

The [crate::BaseSink:async] property can be used to instruct the sink to never perform an ASYNC state change. This feature is mostly usable when dealing with non-synchronized streams or sparse streams.

This is an Abstract Base Class, you cannot instantiate it.

Implements

crate::prelude::BaseSinkExt, gst::prelude::ElementExt, gst::prelude::ObjectExt, trait@glib::object::ObjectExt, crate::prelude::BaseSinkExtManual

Trait Implementations

impl Clone for BaseSink[src]

fn clone(&self) -> BaseSink[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for BaseSink[src]

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

Formats the value using the given formatter. Read more

impl Hash for BaseSink[src]

fn hash<__H: Hasher>(&self, state: &mut __H)[src]

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher
1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl<T: BaseSinkImpl> IsSubclassable<T> for BaseSink[src]

fn class_init(klass: &mut Class<Self>)[src]

Override the virtual methods of this class for the given subclass and do other class initialization. Read more

fn instance_init(instance: &mut InitializingObject<T>)[src]

Instance specific initialization. Read more

impl Ord for BaseSink[src]

fn cmp(&self, other: &BaseSink) -> Ordering[src]

This method returns an Ordering between self and other. Read more

#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]

Compares and returns the maximum of two values. Read more

#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]

Compares and returns the minimum of two values. Read more

#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]

Restrict a value to a certain interval. Read more

impl ParentClassIs for BaseSink[src]

impl<T: ObjectType> PartialEq<T> for BaseSink[src]

fn eq(&self, other: &T) -> bool[src]

This method tests for self and other values to be equal, and is used by ==. Read more

#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for BaseSink[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) -> bool
1.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) -> bool
1.0.0[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl StaticType for BaseSink[src]

fn static_type() -> Type[src]

Returns the type identifier of Self.

impl Eq for BaseSink[src]

impl IsA<Element> for BaseSink[src]

impl IsA<Object> for BaseSink[src]

impl Send for BaseSink[src]

impl StructuralEq for BaseSink[src]

impl Sync for BaseSink[src]

Auto Trait Implementations

impl RefUnwindSafe for BaseSink

impl Unpin for BaseSink

impl UnwindSafe for BaseSink

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[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]

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]

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]

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]

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]

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]

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]

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
    T: ObjectType
[src]

Casts to &T unconditionally. Read more

impl<O> ElementExt for O where
    O: IsA<Element>, 
[src]

pub fn abort_state(&self)[src]

Abort the state change of the element. This function is used by elements that do asynchronous state changes and find out something is wrong. Read more

pub fn add_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
    P: IsA<Pad>, 
[src]

Adds a pad (link point) to self. pad’s parent will be set to self; see crate::prelude::GstObjectExt::set_parent() for refcounting information. Read more

pub fn change_state(
    &self,
    transition: StateChange
) -> Result<StateChangeSuccess, StateChangeError>
[src]

Perform transition on self. Read more

pub fn continue_state(
    &self,
    ret: impl Into<StateChangeReturn>
) -> Result<StateChangeSuccess, StateChangeError>
[src]

Commit the state change of the element and proceed to the next pending state if any. This function is used by elements that do asynchronous state changes. The core will normally call this method automatically when an element returned crate::StateChangeReturn::Success from the state change function. Read more

pub fn create_all_pads(&self)[src]

pub fn foreach_pad<P>(&self, func: P) -> bool where
    P: FnMut(&Element, &Pad) -> bool
[src]

This is supported on crate feature v1_14 only.

pub fn foreach_sink_pad<P>(&self, func: P) -> bool where
    P: FnMut(&Element, &Pad) -> bool
[src]

This is supported on crate feature v1_14 only.

pub fn foreach_src_pad<P>(&self, func: P) -> bool where
    P: FnMut(&Element, &Pad) -> bool
[src]

This is supported on crate feature v1_14 only.

pub fn base_time(&self) -> ClockTime[src]

pub fn bus(&self) -> Option<Bus>[src]

pub fn clock(&self) -> Option<Clock>[src]

pub fn compatible_pad<P>(&self, pad: &P, caps: Option<&Caps>) -> Option<Pad> where
    P: IsA<Pad>, 
[src]

pub fn compatible_pad_template(
    &self,
    compattempl: &PadTemplate
) -> Option<PadTemplate>
[src]

pub fn context(&self, context_type: &str) -> Option<Context>[src]

pub fn contexts(&self) -> Vec<Context, Global>[src]

pub fn factory(&self) -> Option<ElementFactory>[src]

pub fn request_pad_simple(&self, name: &str) -> Option<Pad>[src]

pub fn start_time(&self) -> ClockTime[src]

pub fn state(
    &self,
    timeout: ClockTime
) -> (Result<StateChangeSuccess, StateChangeError>, State, State)
[src]

pub fn static_pad(&self, name: &str) -> Option<Pad>[src]

pub fn is_locked_state(&self) -> bool[src]

pub fn lost_state(&self)[src]

pub fn no_more_pads(&self)[src]

pub fn provide_clock(&self) -> Option<Clock>[src]

pub fn release_request_pad<P>(&self, pad: &P) where
    P: IsA<Pad>, 
[src]

pub fn remove_pad<P>(&self, pad: &P) -> Result<(), BoolError> where
    P: IsA<Pad>, 
[src]

pub fn request_pad(
    &self,
    templ: &PadTemplate,
    name: Option<&str>,
    caps: Option<&Caps>
) -> Option<Pad>
[src]

pub fn set_base_time(&self, time: ClockTime)[src]

pub fn set_bus(&self, bus: Option<&Bus>)[src]

pub fn set_clock<P>(&self, clock: Option<&P>) -> Result<(), BoolError> where
    P: IsA<Clock>, 
[src]

pub fn set_context(&self, context: &Context)[src]

pub fn set_locked_state(&self, locked_state: bool) -> bool[src]

pub fn set_start_time(&self, time: ClockTime)[src]

pub fn set_state(
    &self,
    state: State
) -> Result<StateChangeSuccess, StateChangeError>
[src]

pub fn sync_state_with_parent(&self) -> Result<(), BoolError>[src]

pub fn connect_no_more_pads<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O) + Send + Sync
[src]

pub fn connect_pad_added<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O, &Pad) + Send + Sync
[src]

pub fn connect_pad_removed<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O, &Pad) + Send + Sync
[src]

impl<O> ElementExtManual for O where
    O: IsA<Element>, 
[src]

pub fn element_class(&self) -> &Class<Element>[src]

pub fn current_state(&self) -> State[src]

pub fn pending_state(&self) -> State[src]

pub fn query(&self, query: &mut QueryRef) -> bool[src]

pub fn send_event(&self, event: Event) -> bool[src]

pub fn metadata<'a>(&self, key: &str) -> Option<&'a str>[src]

pub fn pad_template(&self, name: &str) -> Option<PadTemplate>[src]

pub fn pad_template_list(&self) -> Vec<PadTemplate, Global>[src]

pub fn set_element_flags(&self, flags: ElementFlags)[src]

pub fn unset_element_flags(&self, flags: ElementFlags)[src]

pub fn element_flags(&self) -> ElementFlags[src]

pub fn message_full<T>(
    &self,
    type_: ElementMessageType,
    code: T,
    message: Option<&str>,
    debug: Option<&str>,
    file: &str,
    function: &str,
    line: u32
) where
    T: MessageErrorDomain
[src]

pub fn message_full_with_details<T>(
    &self,
    type_: ElementMessageType,
    code: T,
    message: Option<&str>,
    debug: Option<&str>,
    file: &str,
    function: &str,
    line: u32,
    structure: Structure
) where
    T: MessageErrorDomain
[src]

This is supported on crate feature v1_10 only.

pub fn post_message(&self, message: Message) -> Result<(), BoolError>[src]

pub fn post_error_message(&self, msg: ErrorMessage)[src]

pub fn iterate_pads(&self) -> Iterator<Pad>[src]

pub fn iterate_sink_pads(&self) -> Iterator<Pad>[src]

pub fn iterate_src_pads(&self) -> Iterator<Pad>[src]

pub fn pads(&self) -> Vec<Pad, Global>[src]

pub fn sink_pads(&self) -> Vec<Pad, Global>[src]

pub fn src_pads(&self) -> Vec<Pad, Global>[src]

pub fn num_pads(&self) -> u16[src]

pub fn num_sink_pads(&self) -> u16[src]

pub fn num_src_pads(&self) -> u16[src]

pub fn add_property_deep_notify_watch(
    &self,
    property_name: Option<&str>,
    include_value: bool
) -> NotifyWatchId
[src]

This is supported on crate feature v1_10 only.

pub fn add_property_notify_watch(
    &self,
    property_name: Option<&str>,
    include_value: bool
) -> NotifyWatchId
[src]

This is supported on crate feature v1_10 only.

pub fn remove_property_notify_watch(&self, watch_id: NotifyWatchId)[src]

This is supported on crate feature v1_10 only.

pub fn query_convert<V, U>(&self, src_val: V) -> Option<U> where
    V: Into<GenericFormattedValue>,
    U: SpecificFormattedValue
[src]

pub fn query_convert_generic<V>(
    &self,
    src_val: V,
    dest_format: Format
) -> Option<GenericFormattedValue> where
    V: Into<GenericFormattedValue>, 
[src]

pub fn query_duration<T>(&self) -> Option<T> where
    T: SpecificFormattedValue
[src]

pub fn query_duration_generic(
    &self,
    format: Format
) -> Option<GenericFormattedValue>
[src]

pub fn query_position<T>(&self) -> Option<T> where
    T: SpecificFormattedValue
[src]

pub fn query_position_generic(
    &self,
    format: Format
) -> Option<GenericFormattedValue>
[src]

pub fn seek<V>(
    &self,
    rate: f64,
    flags: SeekFlags,
    start_type: SeekType,
    start: V,
    stop_type: SeekType,
    stop: V
) -> Result<(), BoolError> where
    V: Into<GenericFormattedValue>, 
[src]

pub fn seek_simple<V>(
    &self,
    seek_flags: SeekFlags,
    seek_pos: V
) -> Result<(), BoolError> where
    V: Into<GenericFormattedValue>, 
[src]

pub fn call_async<F>(&self, func: F) where
    F: FnOnce(&O) + Send + 'static, 
[src]

This is supported on crate feature v1_10 only.

pub fn call_async_future<F, T>(
    &self,
    func: F
) -> Pin<Box<dyn Future<Output = T> + 'static + Send, Global>> where
    F: FnOnce(&O) -> T + Send + 'static,
    T: Send + 'static, 
[src]

This is supported on crate feature v1_10 only.

pub fn current_running_time(&self) -> ClockTime[src]

pub fn current_clock_time(&self) -> ClockTime[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<O> GObjectExtManualGst for O where
    O: IsA<Object>, 
[src]

pub fn set_property_from_str(&self, name: &str, value: &str)[src]

impl<O> GstObjectExt for O where
    O: IsA<Object>, 
[src]

pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
    P: IsA<ControlBinding>, 
[src]

Attach the crate::ControlBinding to the object. If there already was a crate::ControlBinding for this property it will be replaced. Read more

pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]

A default error function that uses g_printerr() to display the error message and the optional debug string.. Read more

pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]

Gets the corresponding crate::ControlBinding for the property. This should be unreferenced again after use. Read more

pub fn control_rate(&self) -> ClockTime[src]

Obtain the control-rate for this self. Audio processing crate::Element objects will use this rate to sub-divide their processing loop and call Self::sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds. Read more

pub fn name(&self) -> GString[src]

Returns a copy of the name of self. Caller should g_free() the return value after usage. For a nameless object, this returns None, which you can safely g_free() as well. Read more

pub fn parent(&self) -> Option<Object>[src]

Returns the parent of self. This function increases the refcount of the parent object so you should [Self::unref()] it after usage. Read more

pub fn path_string(&self) -> GString[src]

Generates a string describing the path of self in the object hierarchy. Only useful (or used) for debugging. Read more

pub fn value(&self, property_name: &str, timestamp: ClockTime) -> Option<Value>[src]

Gets the value for the given controlled property at the requested time. Read more

pub fn has_active_control_bindings(&self) -> bool[src]

Check if the self has active controlled properties. Read more

pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
    P: IsA<Object>, 
[src]

Check if self has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more

pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
    P: IsA<Object>, 
[src]

Check if self has an ancestor ancestor somewhere up in the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more

pub fn has_as_parent<P>(&self, parent: &P) -> bool where
    P: IsA<Object>, 
[src]

Check if parent is the parent of self. E.g. a crate::Element can check if it owns a given crate::Pad. Read more

pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
    P: IsA<ControlBinding>, 
[src]

Removes the corresponding crate::ControlBinding. If it was the last ref of the binding, it will be disposed. Read more

pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]

This function is used to disable the control bindings on a property for some time, i.e. Self::sync_values() will do nothing for the property. Read more

pub fn set_control_bindings_disabled(&self, disabled: bool)[src]

This function is used to disable all controlled properties of the self for some time, i.e. Self::sync_values() will do nothing. Read more

pub fn set_control_rate(&self, control_rate: ClockTime)[src]

Change the control-rate for this self. Audio processing crate::Element objects will use this rate to sub-divide their processing loop and call Self::sync_values() in between. The length of the processing segment should be up to control-rate nanoseconds. Read more

pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
    P: IsA<Object>, 
[src]

Sets the parent of self to parent. The object’s reference count will be incremented, and any floating reference will be removed (see [crate::Object::ref_sink()]). Read more

pub fn suggest_next_sync(&self) -> ClockTime[src]

Returns a suggestion for timestamps where buffers should be split to get best controller results. Read more

pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]

Sets the properties of the object, according to the GstControlSources that (maybe) handle them and for the given timestamp. Read more

pub fn unparent(&self)[src]

Clear the parent of self, removing the associated reference. This function decreases the refcount of self. Read more

pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
    F: 'static + Fn(&O) + Send + Sync
[src]

impl<O> GstObjectExtManual for O where
    O: IsA<Object>, 
[src]

pub fn connect_deep_notify<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync
[src]

pub fn set_object_flags(&self, flags: ObjectFlags)[src]

pub fn unset_object_flags(&self, flags: ObjectFlags)[src]

pub fn object_flags(&self) -> ObjectFlags[src]

pub fn g_value_array(
    &self,
    property_name: &str,
    timestamp: ClockTime,
    interval: ClockTime,
    values: &mut [Value]
) -> Result<(), BoolError>
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ObjectExt for T where
    T: ObjectType
[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]

pub fn class_of<U>(&self) -> Option<&Class<U>> where
    U: IsClass
[src]

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
    U: IsInterface
[src]

pub fn set_properties(
    &self,
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
[src]

pub fn set_properties_from_value(
    &self,
    property_values: &[(&str, Value)]
) -> Result<(), BoolError>
[src]

pub fn set_property<'a, N, V>(
    &self,
    property_name: N,
    value: V
) -> Result<(), BoolError> where
    V: ToValue,
    N: Into<&'a str>, 
[src]

pub fn set_property_from_value<'a, N>(
    &self,
    property_name: N,
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>, 
[src]

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>, 
[src]

pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
    QD: 'static, 
[src]

Safety Read more

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]

Safety Read more

pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
    QD: 'static, 
[src]

Safety Read more

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]

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]

pub fn connect_notify_local<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: 'static + Fn(&T, &ParamSpec), 
[src]

pub unsafe fn connect_notify_unsafe<F>(
    &self,
    name: Option<&str>,
    f: F
) -> SignalHandlerId where
    F: Fn(&T, &ParamSpec), 
[src]

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>, 
[src]

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]

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>, 
[src]

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>, 
[src]

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]

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]

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]

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]

Emit signal by signal id.

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]

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]

pub fn ref_count(&self) -> u32[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.

pub fn emit_by_name_with_values<'a, N>(
    &self,
    signal_name: N,
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>, 
[src]

Same as emit_by_name but takes Value for the arguments.

pub fn emit_with_details_and_values(
    &self,
    signal_id: SignalId,
    details: Quark,
    args: &[Value]
) -> Result<Option<Value>, BoolError>
[src]

Same as emit_with_details but takes Value for the arguments.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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]

🔬 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]

pub fn to_send_value(&self) -> SendValue[src]

Returns a SendValue clone of self.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<Super, Sub> CanDowncast<Sub> for Super where
    Sub: IsA<Super>,
    Super: IsA<Super>, 
[src]

impl<'a, T, C> FromValueOptional<'a> for T where
    C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
    T: FromValue<'a, Checker = C>, 
[src]