Skip to main content

OptionsCollection

Struct OptionsCollection 

Source
pub struct OptionsCollection {
    pub options: Vec<OptionInfo>,
}
Expand description

An owned snapshot of every option in a cpdb_options_t.

Built from D-Bus GetAllOptions responses (zbus backend) or from C cpdb_options_t pointers (FFI backend). After construction, no raw pointers are held - the collection is freely movable and cloneable.

§Example

use cpdb_rs::options::{OptionsCollection, OptionInfo};

let col = OptionsCollection {
    options: vec![OptionInfo {
        name: "copies".to_string(),
        default_value: "1".to_string(),
        group: "General".to_string(),
        supported_values: vec!["1".to_string(), "2".to_string()],
    }],
};
assert_eq!(col.get("copies").unwrap().default_value, "1");

Fields§

§options: Vec<OptionInfo>

Every option discovered, in iteration order of the underlying hash table (which itself is implementation-defined).

Implementations§

Source§

impl OptionsCollection

Source

pub fn from_dbus(raw: Vec<RawOption>) -> Self

Available on crate feature zbus-backend only.

Builds an OptionsCollection from the D-Bus response tuples returned by crate::proxy::PrintBackendProxy::get_all_options().

Source

pub fn len(&self) -> usize

Returns the number of options in this collection.

Source

pub fn is_empty(&self) -> bool

Returns true if this collection has no options.

Source

pub fn get(&self, name: &str) -> Option<&OptionInfo>

Finds an option by name (linear search).

Source

pub fn iter(&self) -> impl Iterator<Item = &OptionInfo>

Returns an iterator over all options.

Source

pub fn groups(&self) -> Vec<&str>

Returns deduplicated group names of all options in their iteration order, skipping empty group names.

Trait Implementations§

Source§

impl Clone for OptionsCollection

Source§

fn clone(&self) -> OptionsCollection

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OptionsCollection

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OptionsCollection

Source§

fn default() -> OptionsCollection

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more