mqi 0.3.0

Idiomatic IBM® MQ Interface (MQI) and MQ Administration Interface (MQAI) APIs
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

use crate::{
    result::{Error, ResultComp, ResultCompErr},
    structs, types,
};

pub struct OpenParamOption<'a, T> {
    pub mqod: structs::MQOD<'a>,
    pub options: T,
}

pub type OpenParam<'a> = OpenParamOption<'a, types::MQOO>;

/// A trait that manipulates the parameters to the [`MQOPEN`](`::libmqm_sys::MQOPEN`) function
#[diagnostic::on_unimplemented(
    message = "{Self} does not implement `OpenOption` so it can't be used as an argument for MQI open"
)]
/// ## Safety
/// This trait can directly manipulate the [`MQOD`](structs::MQOD) structure which is used by [`MQOPEN`](libmqm_sys::MQOPEN).
/// Incorrect values in the [`MQOD`](structs::MQOD) can lead to undefined behaviour.
/// Implementations of the trait must ensure that pointers and offsets contained in the structure point to active data.
pub unsafe trait OpenOption<'oo, T> {
    fn apply_param(&self, param: &mut OpenParamOption<'oo, T>);
}

/// ## Safety
/// This trait can directly manipulate the [`MQOD`](structs::MQOD) structure which is used by [`MQOPEN`](libmqm_sys::MQOPEN).
/// Incorrect values in the [`MQOD`](structs::MQOD) can lead to undefined behaviour.
/// Implementations of the trait must ensure that pointers and offsets contained in the structure point to active data.
pub unsafe trait OpenValue<S> {
    type Error: From<Error> + std::fmt::Debug;

    fn open_consume<'oo, F>(param: &mut OpenParam<'oo>, mqi: F) -> ResultCompErr<Self, Self::Error>
    where
        F: FnOnce(&mut OpenParam<'oo>) -> ResultComp<S>,
        Self: std::marker::Sized;
}

/// ## Safety
/// This trait can directly manipulate the [`MQOD`](structs::MQOD) structure which is used by [`MQOPEN`](libmqm_sys::MQOPEN).
/// Incorrect values in the [`MQOD`](structs::MQOD) can lead to undefined behaviour.
/// Implementations of the trait must ensure that pointers and offsets contained in the structure point to active data.
pub unsafe trait OpenAttr<S, O> {
    fn open_extract<'a, F>(param: &mut OpenParamOption<'a, O>, mqi: F) -> ResultComp<(Self, S)>
    where
        F: FnOnce(&mut OpenParamOption<'a, O>) -> ResultComp<S>,
        Self: Sized;
}