1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
// Copyright 2017 Lyndon Brown // // This file is part of the PulseAudio Rust language binding. // // This library is free software; you can redistribute it and/or modify it under the terms of the // GNU Lesser General Public License as published by the Free Software Foundation; either version // 2.1 of the License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without // even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License along with this library; // if not, see <http://www.gnu.org/licenses/>. //! Version constants and functions. //! //! The constants defined here follow those given in the `sys` crate and thus the C headers. //! //! - They are typically updated only following a new major release of PA. //! - They are not typically updated following a new minor release of PA. i.e. we may declare //! version `12.0` here, but remain compatible with all `12.x`, so long as PA itself continues to //! adhere to semantic versioning (i.e. no breaking changes in minor releases). //! - They are **not** the minimum compatible PA version. We have feature flags for providing //! backwards compatibility with a limited number of past major versions. //! //! Currently: //! //! - We primarily target PA version `12.x` //! - We have backwards compatibility with PA version `11.x` (and it is believed `10.x`) if the //! `pa_encoding_from_string` feature flag is disabled. //! //! When feature flags are used for backwards compatibility, the versions defined here (as of //! version `2.3`) are adjusted to return the newest compatible major version. //! //! The `get_library_version` function always obtains at runtime the version of the actual PA //! library in use. use capi; use std::ffi::CStr; pub use capi::version::Compatibility; /// The newest version of the PulseAudio client library this binding is known to be compatible with. pub const TARGET_VERSION_STRING: &str = capi::version::TARGET_VERSION_STRING; /// The major and minor components of the newest version of the PulseAudio client library this /// binding is known to be compatible with. pub const TARGET_VERSION: (u8, u8) = capi::version::TARGET_VERSION; #[deprecated(since = "2.3.0", note="use `TARGET_VERSION_STRING` instead")] pub const BINDING_TARGET_VERSION: &str = TARGET_VERSION_STRING; /// The current API version, from the PA C header. Note, this seems to be separate from the PA /// version number, where is was `12` for the v0.9.11 release, and has not been changed since /// (c95d0d7dcbca0c531b972ece1004caad95c92936). pub const API_VERSION: u8 = capi::version::PA_API_VERSION; /// The current protocol version. pub const PROTOCOL_VERSION: u16 = capi::version::PA_PROTOCOL_VERSION; #[deprecated(since = "2.3.0", note="use `TARGET_VERSION` instead")] pub const MAJOR: u8 = TARGET_VERSION.0; #[deprecated(since = "2.3.0", note="use `TARGET_VERSION` instead")] pub const MINOR: u8 = TARGET_VERSION.1; #[deprecated(since = "2.3.0", note="not useful, always zero")] pub const MICRO: u8 = 0; /// Gets an indication of PA version compatibility support, depending upon feature flags used. #[inline(always)] pub fn get_compatibility() -> Compatibility { capi::version::get_compatibility() } /// Gets `BINDING_TARGET_VERSION` #[deprecated(since = "2.3.0", note="not useful, confusing name, use `TARGET_VERSION_STRING` directly or `get_compatibility()` instead")] #[inline(always)] pub fn get_headers_version() -> &'static str { #[allow(deprecated)] BINDING_TARGET_VERSION } /// Gets the version of the library actually in use at runtime. #[inline] pub fn get_library_version() -> &'static CStr { unsafe { CStr::from_ptr(capi::pa_get_library_version()) } } /// Evaluates to `true` if the PulseAudio library version targeted by this version of the PA binding /// library is equal or newer than the version specified. pub fn check_version(major: u8, minor: u8, _micro: u8) -> bool { // Note, defined micro version is always zero as of PA v1.0, thus ignored here (TARGET_VERSION.0 > major) || (TARGET_VERSION.0 == major && TARGET_VERSION.1 > minor) }