cpdb-rs 0.1.1

Safe Rust bindings for OpenPrinting cpdb-libs — Common Print Dialog Backends
Documentation 
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
95
96
97

//! Crate-level documentation for `cpdb-rs`.
//!
//! This library provides a native async Rust client for the
//! [Common Print Dialog Backends (CPDB)](https://github.com/OpenPrinting/cpdb-libs)
//! system. It communicates with CPDB backends (e.g. `cpdb-backend-cups`)
//! over D-Bus using [`zbus`], requiring no C dependencies.
//!
//! # Features
//!
//! - `zbus-backend` *(default)* - Native async D-Bus client via [`CpdbClient`].
//!   *(Note: This uses `zbus` with the `tokio` runtime feature exclusively. Other async runtimes like `async-std` are not currently supported by the high-level client).*
//! - `ffi` - Legacy synchronous C FFI bindings via `cpdb-libs`.
//!
//! # Quick start
//!
//! ```no_run
//! # #[cfg(feature = "zbus-backend")]
//! # async fn example() -> cpdb_rs::Result<()> {
//! use cpdb_rs::CpdbClient;
//!
//! let client = CpdbClient::new().await?;
//! let printers = client.get_all_printers().await?;
//!
//! for p in &printers {
//!     println!("{} [{}] - {}", p.name, p.id, p.make_model);
//! }
//!
//! if let Some(p) = printers.first() {
//!     let (options, media) = client
//!         .get_printer_details(&p.id, &p.backend)
//!         .await?;
//!     println!("{} options, {} media sizes", options.len(), media.len());
//! }
//! # Ok(())
//! # }
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs)]

// cpdb-libs is a Unix/D-Bus library — there is no Windows port. Fail fast
// with a useful message instead of letting bindgen emit a confusing linker
// error. WSL Ubuntu is the supported path on Windows hosts; see README.
#[cfg(all(windows, not(docsrs)))]
compile_error!(
    "cpdb-rs only supports Unix targets (Linux fully supported, macOS \
     headers-only). cpdb-libs has no Windows port. If you are on Windows, \
     develop inside WSL (Ubuntu)."
);

pub mod error;
pub mod options;

#[cfg(feature = "zbus-backend")]
pub mod client;
#[cfg(feature = "zbus-backend")]
pub mod config;
#[cfg(feature = "zbus-backend")]
pub mod events;
#[cfg(feature = "zbus-backend")]
pub mod media;
#[cfg(feature = "zbus-backend")]
pub mod proxy;
#[cfg(feature = "zbus-backend")]
pub mod types;
#[cfg(feature = "zbus-backend")]
pub use client::CpdbClient;
#[cfg(feature = "zbus-backend")]
pub use config::PrinterConfig;
#[cfg(feature = "zbus-backend")]
pub use events::{DiscoveryEvent, PrinterSnapshot};
#[cfg(feature = "zbus-backend")]
pub use media::{MarginInfo, MediaCollection, MediaInfo};
#[cfg(feature = "zbus-backend")]
pub use types::PrinterState;

// Re-export core types for convenience.
pub use error::{CpdbError, Result};
pub use options::{OptionInfo, OptionsCollection};

#[cfg(feature = "ffi")]
pub use cpdb_sys as ffi;

#[cfg(feature = "ffi")]
pub use cpdb_sys::callbacks::PrinterUpdate;
#[cfg(feature = "ffi")]
pub use cpdb_sys::{
    common::{
        absolute_path, concat_path, concat_sep, init, option_group, system_config_dir,
        user_config_dir, version,
    },
    frontend::Frontend,
    printer::{
        Margin, Margins, MediaSize, PrintFdHandle, PrintSocketHandle, Printer, TranslationMap,
    },
    settings::{Media, Options, Settings},
};