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

// Copyright 2018-2021 Cargill Incorporated
//
// 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.

//! Actix Web 3 implementation of the Splinter REST API.
//!
//! To create a running instance of the REST API, use `RestApiBuilder` to create
//! a `RunnableRestApi` and then call `run()` to create a `RestApi`.

mod api;
mod builder;
mod runnable;

use actix_web_3::Resource;

pub use api::RestApi;
pub use builder::RestApiBuilder;
pub use runnable::RunnableRestApi;

/// A `ResourceProvider` provides a list of resources.
///
/// This trait serves as a `Resource` factory, which allows dynamically building a REST API at
/// runtime.
pub trait ResourceProvider: Send {
    /// Returns a list of Actix `Resource`s.
    fn resources(&self) -> Vec<Resource>;
}