ews 0.1.2

Data structures and operations relating to the Exchange Web Services API.
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

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

use serde::Deserialize;
use xml_struct::XmlSerialize;

/// A marker trait for EWS operations.
///
/// Types implementing this trait may appear in requests to EWS as the operation
/// to be performed.
///
/// # Usage
///
/// See [`Envelope`] for details.
///
/// [`Envelope`]: crate::soap::Envelope
pub trait Operation: XmlSerialize + sealed::EnvelopeBodyContents + std::fmt::Debug {
    /// The structure returned by EWS in response to requests containing this
    /// operation.
    type Response: OperationResponse;

    /// The name of the operation.
    ///
    /// This is the same as the local part of the name of the XML element used
    /// to represent this option.
    const NAME: &'static str;
}

// Blanket implementation for borrows, so the consumer does not need full
// ownership of the struct instance to use the trait.
impl<T> Operation for &T
where
    T: Operation,
{
    type Response = T::Response;

    const NAME: &'static str = <T as Operation>::NAME;
}

/// A marker trait for EWS operation responses.
///
/// Types implementing this trait may appear in responses from EWS after
/// requesting an operation be performed.
///
/// # Usage
///
/// See [`Envelope`] for details.
///
/// [`Envelope`]: crate::soap::Envelope
pub trait OperationResponse:
    for<'de> Deserialize<'de> + sealed::EnvelopeBodyContents + std::fmt::Debug
{
    /// The type of the messages in the response.
    type Message;

    /// In practice, every operation response contains a single `response_messages` field. This
    /// returns that field.
    fn response_messages(&self) -> &[crate::ResponseClass<Self::Message>];

    /// Convert the response into its internal type.
    fn into_response_messages(self) -> Vec<crate::ResponseClass<Self::Message>>;
}

pub(super) mod sealed {
    /// A trait for structures which may appear in the body of a SOAP envelope.
    pub trait EnvelopeBodyContents {
        /// The name of the element enclosing the contents of this structure
        /// when represented in XML.
        const NAME: &'static str;
    }

    // Blanket implementation for borrows, so the consumer does not need full
    // ownership of the struct instance to generate SOAP envelopes.
    impl<T> EnvelopeBodyContents for &T
    where
        T: EnvelopeBodyContents,
    {
        const NAME: &'static str = T::NAME;
    }
}