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

// Copyright 2020 Tetrate
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! `Envoy` `Host APIs` provided for use by extensions.
//!
//! # Structure
//!
//! Every supported `Envoy` `Host API` is represented by a trait object,
//! e.g. [`Clock`], [`HttpClient`], [`Stats`], etc.
//!
//! Extensions get parameterized with a concrete implementation of `Host API`s
//! at the time of their construction.
//!
//! This way, you can swap a real `Host API` with a mock when unit testing your
//! extension.
//!
//! # Examples
//!
//! #### Parameterize HTTP Filter extension with `Envoy` [`Clock`]:
//!
//! ```
//! # use envoy_sdk as envoy;
//! use envoy::host::Clock;
//!
//! struct MyHttpFilter<'a> {
//!     clock: &'a dyn Clock,
//! }
//!
//! impl<'a> MyHttpFilter<'a> {
//!     /// Creates a new instance parameterized with a given [`Clock`] implementation.
//!     pub fn new(clock: &'a dyn Clock) -> Self {
//!         MyHttpFilter { clock }
//!     }
//!
//!     /// Creates a new instance parameterized with the default [`Clock`] implementation.
//!     pub fn default() -> Self {
//!         Self::new(Clock::default())
//!     }
//! }
//! ```
//!
//! [`Clock`]: time/trait.Clock.html
//! [`HttpClient`]: http/client/trait.HttpClient.html
//! [`Stats`]: stats/trait.Stats.html

pub(crate) use self::error::function;

pub use self::error::{Error, ErrorContext, Result};
pub use self::http::client::{HttpClient, HttpClientRequestHandle, HttpClientResponseOps};
pub use self::shared_data::SharedData;
pub use self::shared_queue::SharedQueue;
pub use self::stats::Stats;
pub use self::stream_info::StreamInfo;
pub use self::time::Clock;
pub use self::types::{ByteString, HeaderMap};

mod types;

pub mod error;
pub mod http;
pub mod log;
pub mod shared_data;
pub mod shared_queue;
pub mod stats;
pub mod stream_info;
pub mod time;