libpulse_mainloop_glib_sys/
lib.rs

1// Copyright 2017 Lyndon Brown
2//
3// This file is part of the PulseAudio Rust language linking library.
4//
5// Licensed under the MIT license or the Apache license (version 2.0), at your option. You may not
6// copy, modify, or distribute this file except in compliance with said license. You can find copies
7// of these licenses either in the LICENSE-MIT and LICENSE-APACHE files, or alternatively at
8// <http://opensource.org/licenses/MIT> and <http://www.apache.org/licenses/LICENSE-2.0>
9// respectively.
10//
11// Portions of documentation are copied from the LGPL 2.1+ licensed PulseAudio C headers on a
12// fair-use basis, as discussed in the overall project readme (available in the git repository).
13
14//! PulseAudio FFI binding for the `libpulse-mainloop-glib` system library.
15//!
16//! This crate does nothing more than offer a simple FFI binding to the C API of the [PulseAudio]
17//! client system library, specifically the GLIB mainloop component only. Please note that there is
18//! a “higher-level” binding available (the [`libpulse-glib-binding`] crate), built on top of this,
19//! which offers a more Rust-oriented interface.
20//!
21//! Unlike the “higher-level” binding just mentioned, virtually no documentation is provided here.
22//! Things that *are* documented here are typically only those directly re-exported by the
23//! “higher-level” binding. Please see either the equivalent documentation in that, or the
24//! documentation of the actual PulseAudio C header files, if you need documentation.
25//!
26//! [`libpulse-glib-binding`]: https://docs.rs/libpulse-glib-binding
27//! [PulseAudio]: https://en.wikipedia.org/wiki/PulseAudio
28
29#![doc(
30    html_logo_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/logo.svg",
31    html_favicon_url = "https://github.com/jnqnfe/pulse-binding-rust/raw/master/favicon.ico"
32)]
33
34#![allow(non_camel_case_types, non_snake_case)]
35
36#![cfg_attr(docsrs, feature(doc_cfg))]
37
38extern crate libpulse_sys as pulse;
39extern crate glib_sys as glib;
40
41use glib::GMainContext;
42use pulse::mainloop::api::pa_mainloop_api;
43
44/// An opaque GLIB main loop object.
45#[repr(C)] pub struct pa_glib_mainloop { _private: [u8; 0] }
46
47#[rustfmt::skip]
48#[link(name = "pulse-mainloop-glib")]
49extern "C" {
50    pub fn pa_glib_mainloop_new(c: *mut GMainContext) -> *mut pa_glib_mainloop;
51    pub fn pa_glib_mainloop_free(g: *mut pa_glib_mainloop);
52    pub fn pa_glib_mainloop_get_api(g: *const pa_glib_mainloop) -> *const pa_mainloop_api;
53}
libpulse_mainloop_glib_sys/lib.rs

libpulse_mainloop_glib_sys/
lib.rs
